swagger_shield 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a77114331c4b36bc63927cffa6d71b64e3edbc2f93874ecab7855669b54ed89e
+  data.tar.gz: 28707bd376642cd675ba0e105d2e9ec930a7ed790241f0dd5c38f802a54afb9e
+SHA512:
+  metadata.gz: cbeaf6b524b1cb69077c6d862b7c4ae8a273b141d8b36b5b8e4e35322c3d77a48d6246d801e30651704e2e8582ed8b7feb13490210140b1038621b9764911e05
+  data.tar.gz: 185fb9066698ef7f206ad6c1e92ad8732bb6da34be8399b9a2450f885c37c18e94f7427835b470389e9a83777bc61ee3cd233ddcaaf5aeadbac302c1d878217d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at arielmcaplan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 swagger_shield.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 amcaplan
+
+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,91 @@
+# SwaggerShield
+
+Tired of getting weird errors when users (or your own clients) submit random
+junk to your Rails API?  `SwaggerShield` is here to save the day!
+
+## Usage
+
+```ruby
+# You can add to any controller, or to ApplicationController if you want
+# SwaggerShield to protect your whole app.
+class ApplicationController < ActionController::API
+  SwaggerShield.protect!(
+    self,
+
+    # replace with the location of your actual swagger YAML file:
+    swagger_file: File.join('config', 'swagger.yml'),
+
+    # add on any valid "if" or "unless" conditionals that can be applied to a
+    # Rails before_action
+    if: -> { current_user.test_user? },
+    unless: -> { params[:skip_swagger_shield] }
+  )
+end
+```
+
+Now, everything will work as before, as long as the requests are properly
+formatted.  But if requests don't match your Swagger spec:
+
+![You Shall Not Pass!](https://i0.wp.com/gifrific.com/wp-content/uploads/2017/11/you-shall-not-pass-gandalf-lotr.gif)
+
+OK, maybe it's not that dramatic.  But your client will see an error pointing to
+exactly what they messed up in the request:
+
+```json
+{
+  "errors": [
+    {
+      "status": "422",
+      "detail": "The property '#/widget/price' of type string did not match the following type: integer",
+      "source": {
+        "pointer": "#/widget/price"
+      }
+    }
+  ]
+}
+```
+
+(Only errors in JSON API format are supported, hopefully that'll be updated
+soon...)
+
+## Warning!
+
+This project is under active development, being built up in stages as bits
+become necessary for projects that make money.  So there's still plenty of stuff
+to implement; use at your own risk.
+
+That said, the project will gratefully accept the implementation of new types,
+better error messaging, etc., basically anything you find useful in your own
+work which seems generally applicable.  So please [contribute](#development)!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger_shield'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger_shield
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amcaplan/swagger_shield. 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).
+
+## Code of Conduct
+
+Everyone interacting in the SwaggerShield project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amcaplan/swagger_shield/blob/master/CODE_OF_CONDUCT.md).

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 "swagger_shield"
+
+# 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/swagger_shield.rb

@@ -0,0 +1,15 @@
+require "swagger_shield/version"
+require "json-schema"
+require "swagger_shield/shield"
+require "swagger_shield/before_action"
+
+module SwaggerShield
+  class << self
+    def protect!(controller, swagger_file:, **opts)
+      shield = SwaggerShield::Shield.new(
+        YAML.load_file(swagger_file)
+      )
+      controller.before_action SwaggerShield::BeforeAction.new(shield), **opts
+    end
+  end
+end

data/lib/swagger_shield/before_action.rb

@@ -0,0 +1,32 @@
+module SwaggerShield
+  class BeforeAction
+    def initialize(shield)
+      @shield = shield
+    end
+
+    def before(controller)
+      request = controller.request
+      params = controller.params
+
+      errors = shield.validate(
+        request.path,
+        request.method,
+        params.to_unsafe_h
+      )
+
+      unless errors.empty?
+        formatted = errors.map { |error|
+          {
+            status: '422',
+            detail: error[:message],
+            source: { pointer: error[:fragment] }
+          }
+        }
+        controller.render json: { errors: formatted }, status: :unprocessable_entity
+      end
+    end
+
+    private
+    attr_reader :shield
+  end
+end

data/lib/swagger_shield/shield.rb

@@ -0,0 +1,114 @@
+module SwaggerShield
+  class Shield
+    def initialize(swagger_spec)
+      @swagger_spec = swagger_spec.deep_dup
+      load_route_definitions!
+    end
+
+    def validate(path, method, params)
+      canonical_path_id = identify_path(path, paths[method])
+
+      JSON::Validator.fully_validate(
+        swagger_spec,
+        params,
+        fragment: "#/route_lookups/#{method}/#{canonical_path_id}/schema",
+        errors_as_objects: true
+      ).map { |error|
+        {
+          message: error[:message].match(/(?<message_part>.*) in schema/)[:message_part],
+          fragment: error[:fragment]
+        }
+      }
+    end
+
+    private
+    attr_reader :swagger_spec
+
+    def paths
+      swagger_spec['route_lookups'] ||= Hash.new do |h, k|
+        h[k] = {}
+      end
+    end
+
+    def load_route_definitions!
+      base_path = swagger_spec.fetch('basePath', '')
+      swagger_spec['paths'].each do |path, methods|
+        path_id_regex = Regexp.new('\A' + base_path + path.gsub(/\{\w+\}/, "[^/]+") + '\z')
+        path_info = {
+          'original_path' => path,
+          'regex' => path_id_regex,
+        }
+
+        methods.each do |method, method_info|
+          required = []
+          properties = {}
+
+          each_param(method_info['parameters']) do |param|
+            required << param['name'] if param['required']
+            properties[param['name']] = param_schema_from(param)
+          end
+
+          paths[method.upcase][path_id_regex.hash.to_s] = {
+            'regex' => path_id_regex,
+            'schema' => {
+              'type' => 'object',
+              'required' => required,
+              'properties' => properties
+            }
+          }
+        end
+      end
+    end
+
+    def each_param(params)
+      (params || []).each do |param|
+        if (schema = param['schema'])
+          if (ref = schema['$ref'])
+            schema = resolve_reference(ref)
+          end
+          schema['properties'].each do |name, definition|
+            yield(
+              'name' => name,
+              'schema' => definition,
+              'required' => schema['required'].include?(name)
+            )
+          end
+        else
+          yield param
+        end
+      end
+    end
+
+    def resolve_reference(ref)
+      ref.match(/#\/(?<path>.*)/)[:path].split('/').inject(swagger_spec) do |resolved, branch|
+        resolved[branch]
+      end
+    end
+
+    def param_schema_from(param)
+      param.fetch('schema') {
+        baseline = param.except('name', 'in', 'required')
+        return baseline unless param['in'] == 'path'
+        case param['type']
+        when 'integer'
+          {
+            'description' => baseline.delete('description'),
+            'anyOf' => [
+              baseline,
+              {
+                'type' => 'string',
+                'pattern' => '\A[0-9]\z'
+              }
+            ]
+          }
+        else
+          baseline
+        end
+      }
+    end
+
+    def identify_path(path, paths)
+      paths.find { |_, info| info['regex'] =~ path }.first
+    end
+  end
+end

data/lib/swagger_shield/version.rb

@@ -0,0 +1,3 @@
+module SwaggerShield
+  VERSION = "0.1.0"
+end

data/swagger_shield.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "swagger_shield/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger_shield"
+  spec.version       = SwaggerShield::VERSION
+  spec.authors       = ["amcaplan"]
+  spec.email         = ["arielmcaplan@gmail.com"]
+
+  spec.summary       = %q{Protect your API from malformed requests with Swagger Shield!}
+  spec.description   = %q{Validates requests to your API against your Swagger spec.}
+  spec.homepage      = "https://github.com/amcaplan/swagger_shield"
+  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_runtime_dependency "json-schema", "~> 2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rails", "~> 5.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.6"
+  spec.add_development_dependency "pry", "~> 0"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: swagger_shield
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- amcaplan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rails
+  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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Validates requests to your API against your Swagger spec.
+email:
+- arielmcaplan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swagger_shield.rb
+- lib/swagger_shield/before_action.rb
+- lib/swagger_shield/shield.rb
+- lib/swagger_shield/version.rb
+- swagger_shield.gemspec
+homepage: https://github.com/amcaplan/swagger_shield
+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.7.1
+signing_key: 
+specification_version: 4
+summary: Protect your API from malformed requests with Swagger Shield!
+test_files: []