RubyGems - restapi - Versions diffs - 0.0.1 - Mend

restapi 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

data/.autotest +3 -0
data/.gitignore +6 -0
data/.rspec +2 -0
data/.rvmrc +1 -0
data/Gemfile +15 -0
data/Gemfile.lock +118 -0
data/MIT-LICENSE +20 -0
data/README.rdoc +0 -0
data/Rakefile +13 -0
data/app/controllers/restapis_controller.rb +11 -0
data/app/public/javascripts/backbone.js +1431 -0
data/app/public/javascripts/bootstrap-collapse.js +138 -0
data/app/public/javascripts/bootstrap.js +1726 -0
data/app/public/javascripts/jquery-1.7.2.js +9404 -0
data/app/public/javascripts/json2.js +487 -0
data/app/public/javascripts/restapi/jst.js +108 -0
data/app/public/javascripts/restapi/restapi.js +14 -0
data/app/public/javascripts/restapi/routers/documentation_router.js +47 -0
data/app/public/javascripts/underscore.js +999 -0
data/app/public/stylesheets/bootstrap-responsive.css +686 -0
data/app/public/stylesheets/bootstrap-responsive.min.css +12 -0
data/app/public/stylesheets/bootstrap.css +3990 -0
data/app/public/stylesheets/bootstrap.min.css +689 -0
data/app/public/stylesheets/restapi/application.css +7 -0
data/app/views/restapis/index.html.erb +47 -0
data/lib/restapi.rb +22 -0
data/lib/restapi/application.rb +155 -0
data/lib/restapi/dsl_definition.rb +119 -0
data/lib/restapi/error_description.rb +15 -0
data/lib/restapi/method_description.rb +38 -0
data/lib/restapi/param_description.rb +48 -0
data/lib/restapi/railtie.rb +9 -0
data/lib/restapi/resource_description.rb +75 -0
data/lib/restapi/restapi_module.rb +54 -0
data/lib/restapi/routing.rb +15 -0
data/lib/restapi/validator.rb +193 -0
data/lib/restapi/version.rb +4 -0
data/restapi.gemspec +23 -0
data/spec/controllers/restapis_controller_spec.rb +13 -0
data/spec/controllers/users_controller_spec.rb +175 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/dogs_controller.rb +22 -0
data/spec/dummy/app/controllers/twitter_example_controller.rb +306 -0
data/spec/dummy/app/controllers/users_controller.rb +211 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/users/doc.html.erb +24 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +45 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +22 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +25 -0
data/spec/dummy/config/environments/production.rb +49 -0
data/spec/dummy/config/environments/test.rb +35 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +10 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/restapi.rb +30 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +69 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +26 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/public/javascripts/application.js +2 -0
data/spec/dummy/public/javascripts/controls.js +965 -0
data/spec/dummy/public/javascripts/dragdrop.js +974 -0
data/spec/dummy/public/javascripts/effects.js +1123 -0
data/spec/dummy/public/javascripts/prototype.js +6001 -0
data/spec/dummy/public/javascripts/rails.js +202 -0
data/spec/dummy/public/stylesheets/.gitkeep +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/spec_helper.rb +32 -0
metadata +207 -0

data/app/public/stylesheets/restapi/application.css ADDED

@@ -0,0 +1,7 @@
+body {
+  padding-top: 20px;
+  padding-bottom: 40px;
+}
+.sidebar-nav {
+  padding: 9px 0;
+}

data/app/views/restapis/index.html.erb ADDED

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>API documentation</title>
+  <link type="text/css" rel="stylesheet" href="/stylesheets/bootstrap.css">
+  <link type="text/css" rel="stylesheet" href="/stylesheets/restapi/application.css">
+  <link type="text/css" rel="stylesheet" href="/stylesheets/bootstrap-responsive.css">
+  <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+<body>
+      <!-- <div class="navbar navbar-fixed-top">
+        <div class="navbar-inner">
+          <div class="container-fluid">
+            <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+              <span class="icon-bar"></span>
+            </a>
+            <a id="api-title" class="brand" href="">Loading...</a>
+            </div>
+          </div>
+        </div>
+      </div> -->
+      <div class="container">
+        <div class="row">
+          <div id='container'></div>
+        </div>
+        <hr>
+        <footer></footer>
+      </div>
+      <script type="text/javascript" src="/javascripts/jquery-1.7.2.js"></script>
+      <script type="text/javascript" src="/javascripts/json2.js"></script>
+      <script type="text/javascript" src="/javascripts/underscore.js"></script>
+      <script type="text/javascript" src="/javascripts/backbone.js"></script>
+      <script type="text/javascript" src="/javascripts/bootstrap-collapse.js"></script>
+      <script type="text/javascript" src="/javascripts/restapi/restapi.js"></script>
+      <script type="text/javascript" src="/javascripts/restapi/jst.js"></script>
+      <script type="text/javascript" src="/javascripts/restapi/routers/documentation_router.js"></script>
+</body>
+</html>

data/lib/restapi.rb ADDED

@@ -0,0 +1,22 @@
+require 'active_support/dependencies'
+require 'rdoc'
+require 'rdoc/markup/to_html'
+# add path to restapi controller to ActiveSupport paths
+%w{ controllers views }.each do |dir|
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+end
+require "restapi/routing"
+require "restapi/restapi_module"
+require "restapi/method_description"
+require "restapi/resource_description"
+require "restapi/param_description"
+require "restapi/error_description"
+require "restapi/validator"
+require "restapi/dsl_definition"
+require "restapi/railtie"
+require "restapi/version"

data/lib/restapi/application.rb ADDED

@@ -0,0 +1,155 @@
+require 'ostruct'
+module Restapi
+  class Application
+    # we need engine just for serving static assets
+    class Engine < Rails::Engine
+      initializer "static assets" do |app|
+        # app.middleware.use ::ActionDispatch::Static, "#{root}/app/public"
+        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/app/public"
+      end
+    end
+    attr_accessor :last_api_args, :last_errors, :last_params, :last_description
+    attr_reader :method_descriptions, :resource_descriptions
+    def initialize
+      super
+      @method_descriptions = Hash.new
+      @resource_descriptions = Hash.new
+      clear_last
+    end
+    # create new method api description
+    def define_method_description(resource_name, method_name)
+      resource_name = get_resource_name(resource_name)
+      puts "defining api for #{resource_name}:#{method_name}"
+      # create new or get existing api
+      key = [resource_name, method_name].join('#')
+      @method_descriptions[key] ||= Restapi::MethodDescription.new(method_name, resource_name, self)
+      # add mapi key to resource api
+      define_resource_description(resource_name).add_method(key)
+      @method_descriptions[key]
+    end
+    # create new resource api description
+    def define_resource_description(resource_name, &block)
+      resource_name = get_resource_name(resource_name)
+      @resource_descriptions[resource_name] ||= Restapi::ResourceDescription.new(resource_name, &block)
+    end
+    # check if there is some saved description
+    def restapi_provided?
+      true unless last_api_args.blank?
+    end
+    # List of all the apis defined in the given scope (and its sub-scopes).
+    # def mapis_for_resource(resource_name)
+      # @method_descriptions.select { |key,val| key.first == controller_name }
+    # end
+    # get api for given method
+    def get_method_description(resource_name, method_name)
+      resource_name = get_resource_name(resource_name)
+      @method_descriptions[[resource_name, method_name].join('#')]
+    end
+    alias :[] :get_method_description
+    # get api for given resource
+    def get_resource_description(resource_name)
+      resource_name = get_resource_name(resource_name)
+      @resource_descriptions[resource_name]
+    end
+    def remove_method_description(resource_name, method_name)
+      resource_name = get_resource_name(resource_name)
+      @method_descriptions.delete [resource_name, method_name].join('#')
+    end
+    def remove_resource_description(resource_name)
+      resource_name = get_resource_name(resource_name)
+      @resource_descriptions.delete resource_name
+    end
+    # Clear all apis in this application.
+    def clear
+      @resource_descriptions.clear
+      @method_descriptions.clear
+    end
+    # clear all saved data
+    def clear_last
+      @last_api_args = nil
+      @last_errors = Array.new
+      @last_params = Hash.new
+      @last_description = nil
+    end
+    # Return the current description, clearing it in the process.
+    def get_description
+      desc = @last_description
+      @last_description = nil
+      desc
+    end
+    def get_errors
+      errors = @last_errors.clone
+      @last_errors.clear
+      errors
+    end
+    def get_api_args
+      api_args = @last_api_args.clone
+      @last_api_args.clear
+      api_args
+    end
+    def get_params
+      params = @last_params.clone
+      @last_params.clear
+      params
+    end
+    def to_json(resource_name, method_name)
+      _resources = if resource_name.blank?
+        resource_descriptions.collect { |_,v| v.to_json }
+      else
+        [@resource_descriptions[resource_name].to_json(method_name)]
+      end
+      {
+        'docs' => {
+          'name' => Restapi.configuration.app_name,
+          'info' => Restapi.configuration.app_info,
+          'copyright' => Restapi.configuration.copyright,
+          'doc_url' => Restapi.configuration.doc_base_url,
+          'api_url' => Restapi.configuration.api_base_url,
+          'resources' => _resources
+        }
+      }
+    end
+    private
+      def get_resource_name(klass)
+        if klass.class == String
+          klass
+        elsif klass.class == Class && klass.ancestors.include?(ActionController::Base)
+          klass.controller_name
+        end
+      end
+  end
+end

data/lib/restapi/dsl_definition.rb ADDED

@@ -0,0 +1,119 @@
+# Restapi DSL functions.
+module Restapi
+  # DSL is a module that provides #api, #error, #param, #error.  Use this
+  # when you'd like to use restapi outside the top level scope.
+  module DSL
+    private
+    # Describe whole resource
+    #
+    # Example:
+    # api :desc => "Show user profile", :path => "/users/", :version => '1.0 - 3.4.2012'
+    # param :id, Fixnum, :desc => "User ID", :required => true
+    # desc <<-EOS
+    #   Long description...
+    # EOS
+    def resource_description(options = {}, &block)
+      Restapi.define_resource_description(self, &block) if block_given?
+    end
+    # Declare an api.
+    #
+    # Example:
+    #   api :desc => "short description",
+    #       :path => "/resource_route",
+    #       :method => "GET"
+    #
+    def api(args)
+      Restapi.last_api_args = args
+    end
+    # Describe the next method.
+    #
+    # Example:
+    #   desc "print hello world"
+    #   def hello_world
+    #     puts "hello world"
+    #   end
+    #
+    def desc(description)
+      if Restapi.last_description
+        raise "Double method description."
+      end
+      Restapi.last_description = description
+    end
+    alias :description :desc
+    # Describe possible errors
+    #
+    # Example:
+    #   error :desc => "speaker is sleeping", :code => 500
+    #   def hello_world
+    #     return 500 if self.speaker.sleeping?
+    #     puts "hello world"
+    #   end
+    #
+    def error(args)
+      Restapi.last_errors << Restapi::ErrorDescription.new(args)
+    end
+    # Describe method's parameter
+    #
+    # Example:
+    #   param :greeting, String, :desc => "arbitrary text", :required => true
+    #   def hello_world(greeting)
+    #     puts greeting
+    #   end
+    #
+    def param(param_name, *args, &block)
+      Restapi.last_params[param_name.to_sym] = Restapi::ParamDescription.new(param_name, *args, &block)
+    end
+    # create method api and redefine newly added method
+    def method_added(method_name)
+      super
+      return unless Restapi.restapi_provided?
+      method_name = method_name.to_sym
+      resource_name = self.controller_name
+      # remove mapi if exists and create new one
+      Restapi.remove_method_description(resource_name, method_name)
+      mapi = Restapi.define_method_description(resource_name, method_name)
+      # redefine method only if validation is turned on
+      if Restapi.configuration.validate == true
+        old_method = instance_method(method_name)
+        define_method(method_name) do |*args|
+          mapi.params.each do |_, param|
+            # check if required parameters are present
+            if param.required && !params.has_key?(param.name)
+              raise ArgumentError.new("Expecting #{param.name} parameter.")
+            end
+            # params validations
+            if params.has_key?(param.name)
+              param.validate(params[:"#{param.name}"])
+            end
+          end # params.each
+          # run the original method code
+          old_method.bind(self).call(*args)
+        end
+      end
+    end # def method_added
+  end # module DSL
+end # module Restapi

data/lib/restapi/error_description.rb ADDED

@@ -0,0 +1,15 @@
+module Restapi
+  class ErrorDescription
+    attr_reader :code, :description
+    def initialize(args)
+      args ||= []
+      @code = args[:code] || args['code']
+      @description = args[:desc] || args[:description] || args['desc'] || args['description']
+    end
+  end
+end

data/lib/restapi/method_description.rb ADDED

@@ -0,0 +1,38 @@
+module Restapi
+  class MethodDescription
+    attr_reader :errors, :params, :full_description, :method, :resource, :short_description, :path, :http
+    def initialize(method, resource, app)
+      @method = method
+      @resource = resource
+      args = app.get_api_args
+      @short_description = args[:desc] || args[:short] || args[:description]
+      @path = args[:path]
+      @http = args[:method]
+      desc = app.get_description || ''
+      @full_description = Restapi.rdoc.convert(desc.strip_heredoc)
+      @errors = app.get_errors
+      @params = app.get_params
+    end
+    def doc_url; "#{Restapi.configuration.doc_base_url}/#{@resource}/#{@method}"; end
+    def api_url; "#{Restapi.configuration.api_base_url}#{@path}"; end
+    def to_json
+      {
+        :doc_url => doc_url,
+        :api_url => api_url,
+        :name => @method,
+        :http_method => @http,
+        :short_description => @short_description,
+        :full_description => @full_description,
+        :errors => @errors,
+        :params => @params.collect { |_,v| v.to_json }
+      }
+    end
+  end
+end

data/lib/restapi/param_description.rb ADDED

@@ -0,0 +1,48 @@
+module Restapi
+  # method parameter description
+  #
+  # name - method name (show)
+  # desc - description
+  # required - boolean if required
+  # validator - Validator::BaseValidator subclass
+  class ParamDescription
+    attr_reader :name, :desc, :required, :validator
+    def initialize(name, *args, &block)
+      if args.size > 1 || !args.first.is_a?(Hash)
+        validator_type = args.shift || nil
+      else
+        validator_type = nil
+      end
+      options = args.pop || {}
+      @name = name
+      @desc = Restapi.rdoc.convert((options[:desc] || '').strip_heredoc)
+      @required = options[:required] || false
+      @validator = Validator::BaseValidator.find(validator_type, options, block)
+      raise "Validator not found." unless validator
+      @validator.param_name = @name
+    end
+    def validate(value)
+      unless @validator.valid?(value)
+        raise ArgumentError.new(@validator.error)
+      end
+    end
+    def to_json
+      {
+        :name => name,
+        :description => desc,
+        :required => required,
+        :validator => validator.to_s
+      }
+    end
+  end
+end