soar_wadl_validation 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0874ea3f8834fd742b27cce672cb81b6d57d8b2
+  data.tar.gz: d4e08de05bd09d041aa94fefb75d0392ce02a9d2
+SHA512:
+  metadata.gz: 1f3dd9edb6de6fd254712040a02a6073e7a9fe581abcbb9d3507c8e44dc7864584255607bf32beeb8ed97c1e3fc1d100b9fbce610249d7359a154dc85c5e8772
+  data.tar.gz: e2f54dfddb17d9331c1aacf36de71f227c2e4d26d47886885a7add1a24767712bf293a5511b7db00ef33f65551529c82f1b0b83015e90151380e17e0b56d6060

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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,48 @@
+# SoarWadlValidation
+
+Middleware that generates a WADL document describing incoming requests and validates the requests against the WADL.
+
+The validator will return a 400 with jsend JSON fail structure detailing validation failure conditions if WADL validation of the request fails, and call the app provided in the case of successful validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_wadl_validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_wadl_validation
+
+## Usage
+
+Initialize SoarAspects::Aspects with the necessary lexicon, then include this middleware in your middleware stack:
+
+```
+SoarAspects::Aspects::lexicon = lexicon
+```
+
+Then, in your config.ru, place:
+
+```
+  use SoarWadlValidation::Validator
+```
+
+## Contributing
+
+Please send feedback and comments to the author at:
+
+Ernst van Graan <ernst.van.graan@hetzner.co.za>
+
+This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## 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,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 "soar_wadl_validation"
+
+# 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/soar_wadl_validation.rb

@@ -0,0 +1,61 @@
+require 'rack'
+require 'soar_aspects'
+require 'soar_lexicon'
+require 'jsender'
+require "soar_wadl_validation/version"
+
+module SoarWadlValidation
+  class Validator
+    include Jsender
+
+    attr_accessor :app
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      errors = validate(request)
+
+      if not errors.nil?
+        errors.push("Parameter specification: #{request.path}?wadl")
+        error_data = fail(errors, 'Validation failed').to_json
+        return [400, {"Content-Type" => "application/json"} , [error_data]]
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def validate(request)
+      wadl = SoarLexicon::Lexicon::describe_resource(SoarAspects::Aspects::lexicon , request.path)
+      return nil if wadl.nil?
+      pattern = /wadl:param name=\"(?<name>\S+)\" type=\"xsd:(?<type>\S+)\" required=\"(?<required>\S+)\"/
+      entries = wadl.scan(pattern)
+      errors = []
+      entries.each do |entry|
+        if entry[2] == 'true'
+          errors << "Parameter '#{entry[0]}' is required" if not parameter_present?(request.params, entry[0])
+        end
+        # if request.params[entry[0]]
+        #   errors << "Parameter #{entry[0]} is not of type #{entry[1]}" if not request.params[entry[0]].class.is_a?(entry[1])
+        # end
+      end
+      errors.empty? ? nil : errors
+    end   
+
+    def parameter_present?(dictionary, param)
+      nested = param.include?('[') and param.include?(']')
+      if not nested
+        return not(dictionary[param].nil?)
+      else
+        key = param.split('[')[0]
+        nested_key = param.split('[')[1].split(']')[0]
+        return not(dictionary[key].nil? or dictionary[key][nested_key].nil?)
+      end
+      false
+    end
+  end
+end

data/lib/soar_wadl_validation/version.rb

@@ -0,0 +1,3 @@
+module SoarWadlValidation
+  VERSION = "0.1.1"
+end

data/soar_wadl_validation.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_wadl_validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_wadl_validation"
+  spec.version       = SoarWadlValidation::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{WADL validator for requests}
+  spec.description   = %q{WADL validator for requests}
+  spec.homepage      = "https://github.com/hetznerZA/soar_wadl_validation"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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_dependency "rack", "~> 1.6.4"
+  spec.add_dependency "jsender", "~> 0.2.0"
+  spec.add_dependency "soar_aspects", "~> 0.1.2"
+  spec.add_dependency "soar_lexicon", "~> 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"  
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: soar_wadl_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: jsender
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: soar_aspects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: soar_lexicon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: WADL validator for requests
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_wadl_validation.rb
+- lib/soar_wadl_validation/version.rb
+- soar_wadl_validation.gemspec
+homepage: https://github.com/hetznerZA/soar_wadl_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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: WADL validator for requests
+test_files: []