apipie-rails 0.0.7

data/.autotest

@@ -0,0 +1,3 @@
+require "autotest/growl"
+require "autotest/fsevent"
+

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@apipie

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/APACHE-LICENSE-2.0

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    apipie-rails (0.0.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    minitest (3.2.0)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  apipie-rails!
+  minitest
+  rails (>= 3.0.10)
+  rake
+  redcarpet
+  rspec-rails
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Pavel Pokorný
+
+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/NOTICE

@@ -0,0 +1,4 @@
+This gem is released under MIT license. Copy is included in file MIT-LICENSE.
+
+Twitter Bootstrap and google-code-prettify are licensed under Apache License
+2.0. Copy is included in file APACHE-LICENSE-2.0.

data/README.rdoc

@@ -0,0 +1,365 @@
+= API Documentation Tool {<img src="https://secure.travis-ci.org/Pajk/apipie-rails.png?branch=master" alt="Build Status" />}[http://travis-ci.org/Pajk/apipie-rails]
+
+== What?
+
+Every API needs a documentation otherwise no one know how to use it.
+It is not easy to maintain such documentation always up to date if it
+develops over time. Additionaly to this most programmers don't like writing
+documentation and so it could happen that your API is useless because
+of outdated documentation. If the documentation is just text completely
+separated from code then there is no simple way to verify its correctness.
+
+This gem adds some new methods to Rails controllers that can be used
+to describe resources which are exposed by our API. It is meant to
+be used for {RESTful}[http://cs.wikipedia.org/wiki/Representational_State_Transfer]
+web services and because we are talking about Rails you probably know
+what it is all about.
+
+Informations you entered with provided DSL are used to generate
+online documentation and validate values of incoming requests parameters.
+
+== Why?
+
+Documentation will be closer to your code and thus less prone to become
+obsolete. You get documentation frontend without effort. And if you want your
+own design you can do it anytime because json API for your API documentation
+is provided. There are no limits on how to use those informations, the
+builtin web interface is only one of possible options.
+
+Request parameters will be validated before they will get in touch with yours
+controller action or model code. And you inform API users about expected
+parameters values. This information will be always actual because otherwise
+your tests fail (of course you have tests!).
+
+This is how the web interface look like. Try it live on
+http://restapi-likes.rhcloud.com. Example users resource
+description are taken from Twitter(c) API.
+
+https://img.skitch.com/20120428-nruk3e87xs2cu4ydsjujdh11fq.png
+
+https://img.skitch.com/20120428-bni2cmq5cyhjuw1jkd78e3qjxn.png
+
+== How?
+
+=== Gemfile
+
+Add +apipie+ gem to your gemfile and run bundle.
+
+    gem 'apipie-rails'
+
+For bleeding edge version use GitHub version
+
+    gem 'apipie-rails', :git => 'git://github.com/Pajk/apipie-rails.git'
+
+=== Config file
+
+Create configuration file in e.g. */config/initializers/apipie.rb*.
+You can set  application name, footer text, API and documentation base URL
+and turn off validations. You can also choose your favorite markup language
+of full descriptions.
+
+[app_name] Name of your application used in breadcrumbs navigation.
+[copyright] Copyright information (shown in page footer).
+[doc_base_url] Documentation frontend base url.
+[api_base_url] Base url of your API, most probably /api.
+[validate] Parameters validation is turned off when set to false.
+[app_info] Application long description.
+[reload_controllers] Set to enable/disable reloading controllers (and the documentation with it), by default enabled in development.
+[api_controllers_matcher] For reloading to work properly you need to specify where your API controllers are.
+[markup] You can choose markup language for descriptions of your application,
+         resources and methods. RDoc is the default but you can choose from
+         Apipie::Markup::Markdown.new or Apipie::Markup::Textile.new.
+         In order to use Markdown you need Redcarpet gem and for Textile you
+         need RedCloth. Add those to your gemfile and run bundle if you
+         want to use them. You can also add any other markup language
+         processor.
+
+Example:
+
+    Apipie.configure do |config|
+      config.app_name = "Test app"
+      config.copyright = "&copy; 2012 Pavel Pokorny"
+      config.doc_base_url = "/apidoc"
+      config.api_base_url = "/api"
+      config.validate = false
+      config.markup = Apipie::Markup::Markdown.new
+      config.reload_controllers = true
+      config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
+      config.app_info = <<-DOC
+        This is where you can inform user about your application and API
+        in general.
+      DOC
+    end
+
+=== Routes
+
+Add +apipie+ to your *routes.rb*, that's all.
+
+
+=== Resource Description
+
+Resource can be described in corresponding controller by calling +resource_description+ method with block. Parameters described here are used
+for every method unless they are overridden with NilValidator.
+Parameters are inherited in controller hierarchy. So for example you can define
+in base ApplicationController parameters for authentication and they will
+be checked in every request.
+
+[name] You can force resource to display under some alias.
+[short] One line short description.
+[path] Relative URL path of this resource.
+[version] Version of this resource API, use arbitrary string.
+[param] The very same parameter description as you will use method
+        description. Generally use this for parameters that apply
+        to every method in the controller (such as :user hash).
+        It is possible to hide it for individual methods by setting
+        it's validator to nil.
+[description] The full multiline description of the resource and
+              yours API options
+
+Example:
+
+    class UsersController < ApplicationController
+
+      resource_description do
+        name 'Members'
+        short 'Site members'
+        path '/users'
+        version '1.0 - 3.4.2012'
+        param :id, Fixnum, :desc => "User ID", :required => false
+        param :user, Hash, :desc => 'Param description for all methods' do
+          param :username, String, :required => true,
+                :desc => "Username for login"
+          param :password, String, :required => true,
+                :desc => "Password for login"
+        end
+        description <<-DOC
+          Full description of this resource.
+        DOC
+      end
+      #...
+    end
+
+
+=== Method Description
+
+Then describe methods available to your API.
+
+[api] Say how is this method exposed and provide short description.
+      The first parameter is HTTP method (one of :GET/:POST/:PUT/:DELETE).
+      The second parameter is relative URL path which is mapped to this
+      method. The last parameter is methods short description.
+      You can use this +api+ method more than once for one method. It could
+      be useful when there are more routes mapped to it.
+[param] Look at Parameter description section for details.
+[error] Describe each possible error that can happend what calling this
+        method. HTTP response code and description can be provided.
+[description] Full method description which will be converted to HTML by
+              choosen markup language processor.
+[example] Provide example of server response, whole communication or response type.
+          It will be formatted as code.
+[see] Provide reference to another method, this has to be string with
+      controller_name#method_name. 
+
+Example:
+
+   api :GET, "/users/:id", "Show user profile"
+   error :code => 401, :desc => "Unauthorized"
+   error :code => 404, :desc => "Not Found"
+   param :session, String, :desc => "user is logged in", :required => true
+   param :regexp_param, /^[0-9]* years/, :desc => "regexp param"
+   param :array_param, [100, "one", "two", 1, 2], :desc => "array validator"
+   param :boolean_param, [true, false], :desc => "array validator with boolean"
+   param :proc_param, lambda { |val|
+     val == "param value" ? true : "The only good value is 'param value'."
+   }, :desc => "proc validator"
+   description "method description"
+   example " 'user': {...} "
+   see "users#showme"
+   def show
+     #...
+   end
+
+== Parameter Description
+
+Use +param+ to describe every possible parameter. You can use Hash validator
+in cooperation with block given to param method to describe nested parameters.
+
+[name] The first argument is parameter name as a symbol.
+[validator] Second parameter is parameter validator, choose one from section
+            Validators.
+[desc] Parameter description.
+[required] Set this true/false to make it required/optional.
+           Default is optional
+
+Example:
+
+    param :user, Hash, :desc => "User info" do
+      param :username, String, :desc => "Username for login", :required => true
+      param :password, String, :desc => "Password for login", :required => true
+      param :membership, ["standard","premium"], :desc => "User membership"
+    end
+    def create
+      #...
+    end
+
+
+== Validators
+
+Every parameter needs to have associated validator. For now there are some
+basic validators. You can always provide your own to reach complex
+results.
+If validations are enabled (default state) the parameters of every
+request are validated. If the value is wrong a +ArgumentError+ exception
+is raised and can be rescued and processed. It contains some description
+of parameter value expectations. Validations can be turned off
+in configuration file.
+
+=== TypeValidator
+
+Check the parameter type. Only String, Hash and Array are supported
+for the sake of simplicity. Read more to to find out how to add
+your own validator.
+
+    param :session, String, :desc => "user is logged in", :required => true
+    param :facts, Hash, :desc => "Additional optional facts about the user"
+
+=== RegexpValidator
+
+Check parameter value against given regular expression.
+
+    param :regexp_param, /^[0-9]* years/, :desc => "regexp param"
+
+=== ArrayValidator
+
+Check if parameter value is included given array.
+
+    param :array_param, [100, "one", "two", 1, 2], :desc => "array validator"
+
+=== ProcValidator
+
+If you need more complex validation and you know you won't reuse it you
+can use Proc/lambda validator. Provide your own Proc taking value
+of parameter as the only argument. Return true if value pass validation
+or return some text about what is wrong. _Don't use the keyword *return*
+if you provide instance of Proc (with lambda it is ok), just use the last
+statement return property of ruby_.
+
+    param :proc_param, lambda { |val|
+      val == "param value" ? true : "The only good value is 'param value'."
+    }, :desc => "proc validator"
+
+=== HashValidator
+
+You can describe hash parameters in depth if you provide a block with
+description of nested values.
+
+    param :user, Hash, :desc => "User info" do
+      param :username, String, :desc => "Username for login", :required => true
+      param :password, String, :desc => "Password for login", :required => true
+      param :membership, ["standard","premium"], :desc => "User membership"
+    end
+
+=== NilValidator
+
+In fact there is any NilValidator but setting it to nil can be used to
+override parameters described on resource level.
+
+Example:
+
+    param :user, nil
+    def destroy
+      #...
+    end
+
+=== Adding custom validator
+
+Only basic validators are included but it is really easy to add your own.
+Create new initializer with subclass of Apipie::Validator::BaseValidator.
+Two methods are required to implement - instance method
+<tt>validate(value)</tt> and class method
+<tt>build(param_description, argument, options, block)</tt>.
+
+When searching for validator +build+ method of every subclass of
+Apipie::Validator::BaseValidator is called. The first one whitch return
+constructed validator object is used.
+
+Example: Adding IntegerValidator
+
+We want to check if parameter value is an integer like this:
+
+    param :id, Integer, :desc => "Company ID"
+
+So we create apipie_validators.rb initializer with this content:
+
+    class IntegerValidator < Apipie::Validator::BaseValidator
+
+      def initialize(param_description, argument)
+        super(param_description)
+        @type = argument
+      end
+
+      def validate(value)
+        return false if value.nil?
+        !!(value.to_s =~ \/^[-+]?[0-9]+$/)
+      end
+
+      def self.build(param_description, argument, options, block)
+        if argument == Integer || argument == Fixnum
+          self.new(param_description, argument)
+        end
+      end
+
+      def error
+        "Parameter \#{@param_name} expecting to be \#{@type.name},
+        got: \#{@error_value.class.name}"
+      end
+
+      def description
+        "Parameter has to be #{@type}."
+      end
+    end
+
+Parameters of the build method:
+
+[param_description] Instance of Apipie::ParamDescription contains all
+                    given informations about validated parameter.
+[argument] Specified validator, in our example it is +Integer+
+[options] Hash with specified options, for us just
+          <tt>{:desc => "Company ID"}</tt>
+[block] Block converted into Proc, use it as you desire. In this example nil.
+
+
+== Markup
+
+The default markup language is {RDoc}[http://rdoc.rubyforge.org/RDoc/Markup.html]. It can be changed in
+config file (config.markup=) to one of these:
+[Markdown] Use Apipie::Markup::Markdown.new. You need Redcarpet gem.
+[Textile] Use Apipie::Markup::Textile.new. You need RedCloth gem.
+
+Or provide you own object with <tt>to_html(text)</tt> method.
+For inspiration this is how Textile look like:
+
+    class Textile
+      def initialize
+        require 'RedCloth'
+      end
+      def to_html(text)
+        RedCloth.new(text).to_html
+      end
+    end
+
+== Static page
+
+To generate static version of documentation run <tt>rake apipie:static</tt> task.
+It will create folder with one-page documentation in your public directory. Rename
+or delete it if you want to use 'normal' dynamic version again.
+
+== {CLI client}[https://github.com/Pajk/apipie-rails/wiki/CLI-client]
+
+== {Extractor}[https://github.com/Pajk/apipie-rails/wiki/Extractor]
+
+== Future features
+
+* Dynamic CLI client (read info from documentation API)
+* Add documentation json API description to readme
+* Possibility to create requests from web documentation and check responses