respect-rails 0.1.0

data/test/dummy/app/controllers/caught_exception_controller.rb

@@ -0,0 +1,58 @@
+class CaughtExceptionController < ApplicationController
+  around_filter :validate_schemas!
+  rescue_from_request_validation_error
+
+  def_action_schema :request_validator do |s|
+    s.request do |r|
+      r.query_parameters do |s|
+        s.integer :id, equal_to: 42
+      end
+    end
+  end
+
+  def request_validator
+    @id = params[:id]
+    respond_to do |format|
+      format.json do
+        result = { id: @id }
+        render json: result
+      end
+    end
+  end
+
+  def_action_schema :response_validator do |s|
+    s.response_for do |status|
+      status.ok do |r|
+        r.body do |s|
+          s.integer :id, equal_to: 42
+        end
+      end
+    end
+  end
+  def response_validator
+    @id = params[:id]
+    respond_to do |format|
+      format.html
+      format.json do
+        result = { id: @id }
+        render json: result
+      end
+    end
+  end
+
+  def_action_schema :headers_check do |s|
+    s.request do |r|
+      r.headers do |h|
+        h["X-Test-Header"] = "good"
+      end
+    end
+  end
+  def headers_check
+    respond_to do |format|
+      format.json do
+        render json: {}
+      end
+    end
+  end
+
+end

data/test/dummy/app/controllers/disabled_controller.rb

@@ -0,0 +1,37 @@
+# A controller with default schema loading filter disable
+# validates any way if "validate_schemas" filter is set.
+class DisabledController < ApplicationController
+  # Skipping this filter like this is a bad idea since validation
+  # will never happens. We do this only for test purpose. The only
+  # advantage is to save schema loading time.
+  skip_around_filter :load_schemas!
+  around_filter :validate_schemas!
+
+  # GET /disabled/basic.json
+  def_action_schema :basic do |s|
+    s.request do |r|
+      r.body_parameters do |s|
+        s.integer "param1", equal_to: 42
+      end
+    end
+    s.response_for do |status|
+      status.ok do |r|
+        r.body hash: false do |s|
+          s.hash do |s|
+            s.integer "id", equal_to: 42
+          end
+        end
+      end
+    end
+  end
+
+  def basic
+    respond_to do |format|
+      format.json do
+        result = { id: 42 }
+        render json: result
+      end
+    end
+  end
+
+end

data/test/dummy/app/controllers/manual_validation_controller.rb

@@ -0,0 +1,63 @@
+# An example of manual validation without using any filter.
+class ManualValidationController < ApplicationController
+  # GET /manual_validation/raise_custom_error.json
+  def_action_schema :raise_custom_error do |s|
+    s.request do |r|
+      r.query_parameters do |s|
+        s.integer "param1", equal_to: 42
+      end
+    end
+    s.response_for do |status|
+      status.ok do |r|
+        r.body hash: false do |s|
+          s.hash do |s|
+            s.integer "id", equal_to: 53
+          end
+        end
+      end
+    end
+  end
+
+  def raise_custom_error
+    begin
+      request.validate_schema
+    rescue Respect::Rails::RequestValidationError
+      raise "invalid request schema (raised manually for testing)"
+    end
+  end
+
+  # GET /manual_validation/raise_custom_error.json
+  def_action_schema :raise_custom_error_without_rescue do |s|
+    # FIXME(Nicolas Despres): Factor this schema with "raise_custom_error
+    s.request do |r|
+      r.query_parameters do |s|
+        s.integer "param1", equal_to: 42
+      end
+    end
+    s.response_for do |status|
+      status.ok do |r|
+        r.body do |s|
+          s.integer "id", equal_to: 53
+        end
+      end
+    end
+  end
+
+  def raise_custom_error_without_rescue
+    unless request.validate_schema?
+      raise "invalid request schema"
+    end
+  end
+
+  # GET /manual_validation/no_schema.json
+  def no_schema
+    unless request.validate_schema?
+      raise "should never be raised since requests with no schema are always valid"
+    end
+    respond_to do |format|
+      format.json do
+        render json: {}
+      end
+    end
+  end
+end

data/test/dummy/app/controllers/no_schema_controller.rb

@@ -0,0 +1,17 @@
+# A controller with no associated schema.
+class NoSchemaController < ApplicationController
+
+  # GET /no_schema/basic.json
+  def basic
+    unless request.respond_to?(:validate_schema?)
+      raise "request is instrumented even if no schema defined"
+    end
+    respond_to do |format|
+      format.json do
+        result = { id: 42 }
+        render json: result
+      end
+    end
+  end
+
+end

data/test/dummy/app/controllers/skipped_automatic_validation_controller.rb

@@ -0,0 +1,35 @@
+# A controller disabling the automatic validation filter
+# installed in the super class.
+class SkippedAutomaticValidationController < AutomaticValidationController
+  skip_around_filter :validate_schemas!
+  skip_before_filter :sanitize_params!
+
+  # GET /automatic_validation/basic_get.json
+  def_action_schema :basic_get do |s|
+    s.request do |r|
+      r.body_parameters do |s|
+        s.integer "param1", equal_to: 42
+      end
+    end
+    s.response_for do |status|
+      status.ok do |r|
+        r.body do |s|
+          s.integer "id", equal_to: 42
+        end
+      end
+    end
+  end
+
+  def basic_get
+    unless params['param1'] == 42
+      raise "will be raised since the validator is disabled"
+    end
+    respond_to do |format|
+      format.json do
+        result = { id: 42 }
+        render json: result
+      end
+    end
+  end
+
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/respect/application_macros.rb

@@ -0,0 +1,10 @@
+module Respect
+  # Test module proving that users can easily extend the definition DSL
+  # with their own macros bundled in their own modules organized as they
+  # want.
+  module ApplicationMacros
+    def color_channel(name)
+      float name, in: 0.0..1.0
+    end
+  end
+end

data/test/dummy/app/helpers/respect/circle_schema.rb

@@ -0,0 +1,16 @@
+module Respect
+  # Test class proving that users can easily extend the schema hierarchy
+  # with a custom type based on another custom type.
+  class CircleSchema < CompositeSchema
+    def schema_definition
+      HashSchema.define do |s|
+        s.point "center"
+        s.float "radius", greater_than: 0.0
+      end
+    end
+
+    def sanitize(doc)
+      Circle.new(doc[:center], doc[:radius])
+    end
+  end
+end

data/test/dummy/app/helpers/respect/point_schema.rb

@@ -0,0 +1,19 @@
+module Respect
+  # Test class proving that users can easily extend the schema hierarchy
+  # with a custom type providing both a composition macro and a
+  # sanitizer block.
+  class PointSchema < CompositeSchema
+
+    def schema_definition
+      HashSchema.define do |s|
+        s.float "x"
+        s.float "y"
+      end
+    end
+
+    def sanitize(doc)
+      Point.new(doc["x"], doc["y"])
+    end
+
+  end
+end

data/test/dummy/app/helpers/respect/rgba_schema.rb

@@ -0,0 +1,18 @@
+module Respect
+  class RgbaSchema < CompositeSchema
+    def schema_definition
+      ArraySchema.define do |s|
+        s.items do |s|
+          s.color_channel # red
+          s.color_channel # green
+          s.color_channel # blue
+          s.color_channel # alpha
+        end
+      end
+    end
+
+    def sanitize(doc)
+      Rgba.new(doc[0], doc[1], doc[2], doc[3])
+    end
+  end
+end

data/test/dummy/app/views/automatic_validation/request_format.html.erb

@@ -0,0 +1 @@
+<h1>response</h1>

data/test/dummy/app/views/automatic_validation/request_format.pdf.erb

@@ -0,0 +1 @@
+pdf file

data/test/dummy/app/views/caught_exception/response_validator.html.erb

@@ -0,0 +1 @@
+No response validation for HTML format.

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "respect/rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    config.autoload_paths += %W(#{config.root}/lib/exts)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,67 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/respect.rb

@@ -0,0 +1,9 @@
+Respect::Rails.setup do |config|
+  config.app_documentation <<-EOS.strip_heredoc
+    A great dummy app.
+
+    This is a great dummy app we love to torture.
+  EOS
+
+  config.helpers Respect::ApplicationMacros
+end

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '071af080e1c30e46525e735e6ee518161dc69b206576a48334f25af553f485edb81bd0956ee7e2ad0accf5b3026580763895a5dcfeccc41ecdde0f458e43349c'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"