respect-rails 0.1.0

data/lib/respect/rails.rb

@@ -0,0 +1,74 @@
+require 'respect/rails/engine'
+
+module Respect
+  module Rails
+    extend ActiveSupport::Autoload
+
+    autoload :ActionSchema
+    autoload :ResponseSchemaSet
+    autoload :RequestSchema
+    autoload :ResponseSchema
+    autoload :ActionDef
+    autoload :RequestDef
+    autoload :ResponseDef
+    autoload :Info
+    autoload :ApplicationInfo
+    autoload :EngineInfo
+    autoload :RouteInfo
+    autoload :HeadersSimplifier
+
+    class ValidationError < StandardError
+      def initialize(error, part, object)
+        @error = error
+        @part = ActiveSupport::StringInquirer.new(part.to_s)
+        @object = object
+        @context = error.context + ["in #@part"]
+      end
+
+      attr_reader :error
+      attr_reader :part
+      attr_reader :context
+
+      def message
+        if ::Rails.env.test?
+          @context.join("; ")
+        else
+          @error.message
+        end
+      end
+
+      attr_reader :object
+
+      def to_h
+        {
+          error: {
+            class: self.class.name,
+            message: message,
+            context: context,
+            part: @part,
+            object: @object,
+          }
+        }
+      end
+
+      def to_json
+        ActiveSupport::JSON.encode(self.to_h)
+      end
+    end
+
+    # Raised when we fail to validate an incoming request.
+    class RequestValidationError < ValidationError
+    end
+
+    # Raised when we fail to validate an outgoing response.
+    class ResponseValidationError < ValidationError
+    end
+
+    class << self
+      # Shortcut for {Respect::Rails::Engine.setup}.
+      def setup(&block)
+        Engine.setup(&block)
+      end
+    end # class << self
+  end # module Rails
+end # module Respect

data/lib/tasks/respect_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :respect-rails do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

@@ -0,0 +1,300 @@
+# An example of automatic validation using the "validate_schemas" around filter.
+class AutomaticValidationController < ApplicationController
+  around_filter :validate_schemas!
+  before_filter :sanitize_params!
+
+  # GET /automatic_validation/basic_get.json
+  def_action_schema :basic_get do |s|
+    s.documentation <<-EOS.strip_heredoc
+      A title.
+
+      A description.
+      EOS
+    s.request do |r|
+      r.query_parameters do |s|
+        s.doc <<-EOS.strip_heredoc
+          A parameter
+
+          An important parameter that should be equal to 42.
+          Yes really!.
+          EOS
+        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 "should never be raised since the validator has raised one when checking parameters."
+    end
+    respond_to do |format|
+      format.json do
+        result = { id: 42 }
+        render json: result
+      end
+    end
+  end
+
+  # GET /automatic_validation/no_schema.json
+  def no_schema_at_all
+    respond_to do |format|
+      format.json do
+        render json: {}
+      end
+    end
+  end
+
+  def_action_schema :no_request_schema 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 no_request_schema
+    respond_to do |format|
+      format.json do
+        result = { id: params[:returned_id] }
+        render json: result, status: 200
+      end
+    end
+  end
+
+
+  # Route constraints prevent this endpoint to raise any validation error.
+  def_action_schema :route_constraints do |s|
+    s.request do |r|
+      r.query_parameters do |s|
+        s.string "param1", equal_to: "42"
+      end
+    end
+  end
+
+  def route_constraints
+    unless params['param1'] == "42"
+      raise "should never be rasised since the route has a constraint on this parameter value."
+    end
+    respond_to do |format|
+      format.json do
+        result = { id: 42 }
+        render json: result
+      end
+    end
+  end
+
+  # Composite custom types like Circle and Point are expected in the parameters of this request.
+  def_action_schema :composite_custom_types do |s|
+    s.request do |r|
+      r.query_parameters do |s|
+        s.circle "circle"
+        s.rgba "color"
+      end
+    end
+  end
+
+  def composite_custom_types
+    expected_circle = Circle.new(Point.new(1.0, 2.0), 5.0)
+    circle = params[:circle]
+    unless circle == expected_circle
+      raise "parameter circle '#{circle.inspect}' is not equal to '#{expected_circle.inspect}'"
+    end
+    expected_color = Rgba.new(0.0, 0.1, 0.2, 0.3)
+    color = params[:color]
+    unless color == expected_color
+      raise "parameter color '#{color.inspect}' is not equal to '#{expected_color.inspect}'"
+    end
+    respond_to do |format|
+      format.json do
+        render json: true, status: :ok
+      end
+    end
+  end
+
+  def dump_uri_helpers
+    result = {
+      respect_path: respect_path,
+      respect: {
+        doc_path: respect.doc_path,
+        root_path: respect.root_path,
+      }
+    }
+    respond_to do |format|
+      format.json do
+        render json: result, status: :ok
+      end
+    end
+  end
+
+  def_action_schema :request_contextual_error do |s|
+    s.request do |r|
+      r.query_parameters do |s|
+        s.hash "o1" do |s|
+          s.hash "o2" do |s|
+            s.integer "i", equal_to: 42
+          end
+        end
+      end
+    end
+  end
+
+  def request_contextual_error
+    raise "Error should be raised before me!!"
+  end
+
+  def_action_schema :response_contextual_error do |s|
+    s.response_for do |status|
+      status.is 200 do |r|
+        r.body do |s|
+          s.hash "o1" do |s|
+            s.hash "o2" do |s|
+              s.integer "i", equal_to: 51
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def response_contextual_error
+    respond_to do |format|
+      format.json do
+        result = { o1: { o2: { i: 42 } } }
+        render json: result, status: :ok
+      end
+    end
+  end
+
+  def_action_schema :request_format do |s|
+    s.request do |r|
+      r.query_parameters do |s|
+        s.integer "id", required: false
+      end
+    end
+    s.response_for do |status|
+      status.is :ok do |r|
+        r.body do |s|
+          s.integer "id", equal_to: 42
+        end
+      end
+    end
+  end
+
+  def request_format
+    respond_to do |format|
+      format.json do
+        render json: { id: 42 }, status: :ok
+      end
+      format.html # request_format.html.erb
+      format.pdf do
+        render pdf: "foo", status: :ok
+      end
+    end
+  end
+
+  # POST /automatic_validation/basic_post.json
+  def_action_schema :basic_post do |s|
+    s.request do |r|
+      r.path_parameters do |s|
+        s.integer "path_param", equal_to: 42
+      end
+      r.body_parameters do |s|
+        s.integer "body_param", 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_post
+    unless params['path_param'] == 42
+      raise "should never be raised since the validator has raised one before when checking path_param"
+    end
+    unless params['body_param'] == 42
+      raise "should never be raised since the validator has raised one before when checking body_param"
+    end
+    respond_to do |format|
+      format.json do
+        result = { id: request.request_parameters['response_param'] }
+        render json: result
+      end
+    end
+  end
+
+  def_action_schema :check_request_headers do |s|
+    s.request do |r|
+      r.headers do |h|
+        h["X-Test-Header"] = "value"
+      end
+    end
+  end
+
+  def check_request_headers
+    unless request.headers["X-Test-Header"] == "value"
+      raise "should never be raised since the validator has raised one before when checking headers"
+    end
+    respond_to do |format|
+      format.json do
+        render json: {}
+      end
+    end
+  end
+
+  def_action_schema :check_response_headers do |s|
+    s.response_for do |status|
+      status.ok do |r|
+        r.headers do |h|
+          h["X-Test-Header"] = "good"
+        end
+      end
+    end
+  end
+
+  def check_response_headers
+    headers["X-Test-Header"] = params["response_header_value"]
+    respond_to do |format|
+      format.json do
+        render json: {}
+      end
+    end
+  end
+
+  def_action_schema :only_documentation do |s|
+    s.documentation <<-EOS.strip_heredoc
+      Request with no schema but a documentation.
+
+      It should be documented even if it does not have any schema defined.
+    EOS
+  end
+
+  def only_documentation
+    respond_to do |format|
+      format.json do
+        render json: {}
+      end
+    end
+  end
+
+  def raise_no_method_error_schema
+    raise NoMethodError, "user has raised NoMethodError"
+  end
+
+  def raise_name_error_schema
+    raise NameError, "user has raised a NameError"
+  end
+
+end