superintendent 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a05a8e02df98ffee0c7c0d1e5e02a92962693e3c
+  data.tar.gz: 848d649d35c92c1c30a05cd27f0698b9570916f7
+SHA512:
+  metadata.gz: a75a67e28f8c57f0cefb94954de44f35cd7b6e5cc3d8f38d6058d43274284efaefb879987cd6f276a715bd9e9b1a79b13941831277accff8a701d240d1498a97
+  data.tar.gz: 2c7fd86673ebfa071147e8b849ed65976028dc4da96932c5b95c47ea6274515f869817dc1daf4d0429b4cc82896239ffe863562bc8234b73486295e794e81585

data/.gitignore

@@ -0,0 +1,32 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ben Mills
+
+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,20 @@
+# Superintendent
+
+Middlewares to aid in building powerful JSON API applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'superintendent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install superintendent
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+

data/lib/superintendent.rb

@@ -0,0 +1,6 @@
+module Superintendent
+  require 'superintendent/request/bouncer'
+  require 'superintendent/request/id'
+  require 'superintendent/request/params_case_translator'
+  require 'superintendent/request/validator'
+end

data/lib/superintendent/initializer/register_json_api_mime_type.rb

@@ -0,0 +1,10 @@
+require 'action_dispatch/http/mime_type'
+
+api_mime_types = %W(
+  application/vnd.api+json
+  text/x-json
+  application/json
+)
+
+Mime::Type.unregister :json
+Mime::Type.register 'application/json', :json, api_mime_types

data/lib/superintendent/request/bouncer.rb

@@ -0,0 +1,79 @@
+require 'action_dispatch/http/request'
+
+module Superintendent
+  module Request
+    class Bouncer
+      DEFAULT_OPTS = {
+        required_headers: [],
+        supported_content_types: [
+          'application/json',
+          'application/x-www-form-urlencoded'
+        ]
+      }
+
+      def initialize(app, opts={})
+        @app, @options = app, DEFAULT_OPTS.merge(opts)
+      end
+
+      def call(env)
+        @request = ActionDispatch::Request.new(env)
+
+        if required_keys_missing?
+          return respond_400(
+            {
+              code: 'headers-missing',
+              title: 'Headers missing',
+              detail: 'Required headers were not present in the request'
+            }
+          )
+        end
+
+        if %w[POST PUT PATCH].include? @request.request_method
+          if unsupported_content_type?
+            return respond_400(
+              {
+                code: 'content-type-unsupported',
+                title: 'Request content-type is unsupported',
+                detail: "#{@request.content_type} is not a supported content-type"
+              }
+            )
+          end
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def unsupported_content_type?
+        content_type = @request.content_type
+        return false if content_type.nil? || content_type.empty?
+
+        !@options[:supported_content_types].include? content_type
+      end
+
+      def required_keys_missing?
+        @options[:required_headers].any? { |key| !@request.headers.include?(key) }
+      end
+
+      def respond_400(attributes)
+        [400,
+         {'Content-Type' => 'application/vnd.api+json'},
+         [
+           {
+             errors: [
+               {
+                 attributes: {
+                   id: @request.headers[Id::X_REQUEST_ID],
+                   status: 400
+                 }.merge(attributes),
+                 type: 'errors'
+               }
+             ]
+           }.to_json
+         ]
+        ]
+      end
+    end
+  end
+end

data/lib/superintendent/request/id.rb

@@ -0,0 +1,30 @@
+require 'securerandom'
+
+module Superintendent::Request
+  class Id
+    X_REQUEST_ID = 'X-Request-Id'.freeze
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request_id = make_request_id(env['HTTP_X_REQUEST_ID'])
+      @app.call(env).tap { |_status, headers, _body| headers[X_REQUEST_ID] = request_id }
+    end
+
+    private
+
+    def make_request_id(request_id)
+      if request_id && ! request_id.empty?
+        request_id.gsub(/[^\w\-]/, "".freeze)[0..255]
+      else
+        internal_request_id
+      end
+    end
+
+    def internal_request_id
+      "OHM#{SecureRandom.uuid.gsub!('-', '')}"
+    end
+  end
+end

data/lib/superintendent/request/params_case_translator.rb

@@ -0,0 +1,36 @@
+module Superintendent::Request
+  class ParamsCaseTranslator
+    DATA_CASE = 'HTTP_X_API_DATA_CASE'.freeze
+
+    def initialize(app, opts={})
+      @app, @options = app, opts
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new(env)
+      if ['POST', 'PUT', 'PATCH'].include? request.method
+        if env.has_key?(DATA_CASE) && env[DATA_CASE] == 'camel-lower'
+          request.request_parameters = underscored_keys(request.request_parameters)
+        end
+      end
+      @app.call(env)
+    end
+
+    private
+
+    def underscored_key(k)
+      k.to_s.underscore
+    end
+
+    def underscored_keys(value)
+      case value
+      when Array
+        value.map { |v| underscored_keys(v) }
+      when Hash
+        Hash[value.map { |k, v| [underscored_key(k), underscored_keys(v)] }]
+      else
+        value
+      end
+    end
+  end
+end

data/lib/superintendent/request/validator.rb

@@ -0,0 +1,117 @@
+require 'json-schema'
+require 'action_dispatch/http/mime_type'
+require 'action_dispatch/http/parameters'
+require 'action_dispatch/http/request'
+
+module Superintendent::Request
+  class Validator
+    FORM_METHOD_ACTIONS = {
+      'POST' => 'create',
+      'PATCH' => 'update',
+      'PUT' => 'update'
+    }
+
+    DEFAULT_OPTIONS = {
+      :monitored_content_types => ['application/json']
+    }
+
+    JSON_API_CONTENT_TYPE = 'application/vnd.api+json'.freeze
+
+    def initialize(app, opts={})
+      @app, @options = app, DEFAULT_OPTIONS.merge(opts)
+    end
+
+    def call(env)
+      request = ActionDispatch::Request.new(env)
+
+      # Only manage requests for the selected Mime Types and
+      # FORM_METHOD_ACTIONS.
+      if @options[:monitored_content_types].include?(request.content_type) &&
+        FORM_METHOD_ACTIONS.has_key?(request.request_method)
+
+        request_data = request.request_parameters
+        resource = requested_resource(request.path_info)
+
+        begin
+          forms = "#{resource}Form".constantize
+          form = form_for_method(forms, request.request_method)
+        rescue NameError => e
+          return respond_404 # Return a 404 if no form was found.
+        end
+
+        errors = JSON::Validator.fully_validate(
+          form, request_data, { errors_as_objects: true })
+
+        if ! errors.empty?
+          return respond_400(serialize_errors(request.headers[Id::X_REQUEST_ID], errors))
+        end
+        drop_extra_params!(form, request_data) unless request_data.blank?
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    # Parameters that are not in the form are removed from the request so they
+    # never reach the controller.
+    def drop_extra_params!(form, data)
+      form_data = form['properties']['data']['properties']
+      allowed_params = form_data['attributes']['properties'].keys rescue nil
+      allowed_params.nil? ? nil : data['data']['attributes'].slice!(*allowed_params)
+    end
+
+    def form_for_method(forms, request_method)
+      forms.send(FORM_METHOD_ACTIONS[request_method]).with_indifferent_access
+    end
+
+    # Adjust the errors returned from the schema validator so they can be
+    # reused in the serialized error response.
+    def adjust_errors(form_errors)
+      form_errors.each do |e|
+        case e[:failed_attribute]
+        when 'Required'
+          e[:message].gsub!("The property '#/'", 'The request')
+        end
+        e[:message].gsub!("The property '#/", "The property '")
+        e[:message] = e[:message][/.+?(?= in schema)/]
+      end
+    end
+
+    def serialize_errors(request_id, form_errors)
+      form_errors = adjust_errors(form_errors)
+      errors = []
+      form_errors.each do |e|
+        error = {
+          id: request_id,
+          status: 400,
+          code: e[:failed_attribute].underscore.dasherize,
+          title: e[:failed_attribute],
+          detail: e[:message]
+        }
+        errors << { attributes: error, type: 'errors' }
+      end
+      JSON.pretty_generate({errors: errors})
+    end
+
+    # Determine the requested resource based on the requested endpoint
+    def requested_resource(request_path)
+      parts = request_path.split('/')
+      # if the last part is an ID, return the part before it, the resource.
+      if (parts[-1]=~/(\d+|[A-Z]{2}[a-zA-Z0-9]{32})/)
+        resource = parts[-2]
+      else
+        resource = parts[-1]
+      end
+      resource.singularize.classify
+    end
+
+    def respond_400(errors)
+      [400, {'Content-Type' => JSON_API_CONTENT_TYPE}, [errors]]
+    end
+
+    def respond_404
+      [404, {'Content-Type' => JSON_API_CONTENT_TYPE}, ['']]
+    end
+  end
+end

data/lib/superintendent/version.rb

@@ -0,0 +1,3 @@
+module Superintendent
+  VERSION = "0.0.1"
+end

data/superintendent.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'superintendent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "superintendent"
+  spec.version       = Superintendent::VERSION
+  spec.authors       = ["Ben Mills"]
+  spec.email         = ["ben@unfiniti.com"]
+
+  spec.summary       = "Middlewares to aid in building powerful JSON API applications."
+  spec.description   = "Middlewares to aid in building powerful JSON API applications."
+  spec.homepage      = "https://github.com/remear/superintendent"
+  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 'rack', '>= 2.0.0.alpha', '< 3.0'
+  spec.add_runtime_dependency 'json-schema', '~> 2.5'
+  spec.add_runtime_dependency 'activesupport', '>= 5.0.0.beta1', '< 5.1'
+  spec.add_runtime_dependency 'actionpack', '>= 5.0.0.beta1', '< 5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency "rake", '>= 10.4', '< 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'mocha', '~> 1.1'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: superintendent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Mills
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-09 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.0.alpha
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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
+  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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry-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: Middlewares to aid in building powerful JSON API applications.
+email:
+- ben@unfiniti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/superintendent.rb
+- lib/superintendent/initializer/register_json_api_mime_type.rb
+- lib/superintendent/request/bouncer.rb
+- lib/superintendent/request/id.rb
+- lib/superintendent/request/params_case_translator.rb
+- lib/superintendent/request/validator.rb
+- lib/superintendent/version.rb
+- superintendent.gemspec
+homepage: https://github.com/remear/superintendent
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Middlewares to aid in building powerful JSON API applications.
+test_files: []