apipie-rails 0.0.7

data/lib/apipie/helpers.rb

@@ -0,0 +1,24 @@
+module Apipie
+  module Helpers
+    def markup_to_html(text)
+      Apipie.configuration.markup.to_html(text.strip_heredoc)
+    end
+
+    attr_accessor :url_prefix
+
+    def full_url(path)
+      unless @url_prefix
+        @url_prefix = ""
+        if rails_prefix = ENV["RAILS_RELATIVE_URL_ROOT"]
+          @url_prefix << rails_prefix
+        end
+        @url_prefix << Apipie.configuration.doc_base_url
+      end
+      path = path.sub(/^\//,"")
+      ret = "#{@url_prefix}/#{path}"
+      ret.insert(0,"/") unless ret =~ /\A[.\/]/
+      ret.sub!(/\/*\Z/,"")
+      ret
+    end
+  end
+end

data/lib/apipie/markup.rb

@@ -0,0 +1,45 @@
+module Apipie
+
+  module Markup
+
+    class RDoc
+
+      def initialize
+        require 'rdoc'
+        require 'rdoc/markup/to_html'
+        @rdoc ||= ::RDoc::Markup::ToHtml.new
+      end
+
+      def to_html(text)
+        @rdoc.convert(text)
+      end
+
+    end
+
+    class Markdown
+
+      def initialize
+        require 'redcarpet'
+        @redcarpet ||= ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML.new)
+      end
+
+      def to_html(text)
+        @redcarpet.render(text)
+      end
+
+    end
+
+    class Textile
+
+      def initialize
+        require 'RedCloth'
+      end
+
+      def to_html(text)
+        RedCloth.new(text).to_html
+      end
+
+    end
+
+  end
+end

data/lib/apipie/method_description.rb

@@ -0,0 +1,150 @@
+require 'set'
+module Apipie
+
+  class MethodDescription
+
+    class Api
+
+      attr_accessor :short_description, :api_url, :http_method
+
+      def initialize(method, path, desc)
+        @http_method = method.to_s
+        @api_url = create_api_url(path)
+        @short_description = desc
+      end
+
+      private
+
+      def create_api_url(path)
+        "#{Apipie.configuration.api_base_url}#{path}"
+      end
+
+    end
+
+    attr_reader :errors, :full_description, :method, :resource, :apis, :examples, :see
+
+    def initialize(method, resource, app)
+      @method = method
+      @resource = resource
+
+      @apis = app.get_api_args
+      @see = app.get_see
+
+      desc = app.get_description || ''
+      @full_description = Apipie.markup_to_html(desc)
+      @errors = app.get_errors
+      @params_ordered = app.get_params
+      @examples = app.get_examples
+
+      @examples += load_recorded_examples
+
+      parent = @resource.controller.superclass
+      if parent != ActionController::Base
+        @parent_resource = parent.controller_name
+      end
+      @resource.add_method(id)
+    end
+
+    def id
+      "#{resource._id}##{method}"
+    end
+
+    def params
+      params_ordered.reduce({}) { |h,p| h[p.name] = p; h }
+    end
+
+    def params_ordered
+      all_params = []
+      # get params from parent resource description
+      if @parent_resource
+        parent = Apipie.get_resource_description(@parent_resource)
+        merge_params(all_params, parent._params_ordered) if parent
+      end
+
+      # get params from actual resource description
+      if @resource
+        merge_params(all_params, resource._params_ordered)
+      end
+
+      merge_params(all_params, @params_ordered)
+      all_params.find_all(&:validator)
+    end
+
+    def doc_url
+      Apipie.full_url("#{@resource._id}/#{@method}")
+    end
+
+    def method_apis_to_json
+      @apis.each.collect do |api|
+        {
+          :api_url => api.api_url,
+          :http_method => api.http_method.to_s,
+          :short_description => api.short_description
+        }
+      end
+    end
+
+    def see_url
+      if @see
+        method_description = Apipie[@see]
+        if method_description.nil?
+          raise ArgumentError.new("Method #{@see} referenced in 'see' does not exist.")
+        end
+        method_description.doc_url
+      end
+    end
+
+    def see
+      @see
+    end
+
+    def to_json
+      {
+        :doc_url => doc_url,
+        :name => @method,
+        :apis => method_apis_to_json,
+        :full_description => @full_description,
+        :errors => @errors,
+        :params => params_ordered.map(&:to_json).flatten,
+        :examples => @examples,
+        :see => @see,
+        :see_url => see_url
+      }
+    end
+
+    private
+
+    def merge_params(params, new_params)
+      new_param_names = Set.new(new_params.map(&:name))
+      params.delete_if { |p| new_param_names.include?(p.name) }
+      params.concat(new_params)
+    end
+
+    def load_recorded_examples
+      (Apipie.recorded_examples[id] || []).
+        find_all { |ex| ex["show_in_doc"].to_i > 0 }.
+        sort_by { |ex| ex["show_in_doc"] }.
+        map { |ex| format_example(ex.symbolize_keys) }
+    end
+
+    def format_example_data(data)
+      case data
+      when Array, Hash
+        JSON.pretty_generate(data).gsub(/: \[\s*\]/,": []").gsub(/\{\s*\}/,"{}")
+      else
+        data
+      end
+    end
+
+    def format_example(ex)
+      example = "#{ex[:verb]} #{ex[:path]}"
+      example << "?#{ex[:query]}" unless ex[:query].blank?
+      example << "\n" << format_example_data(ex[:request_data]).to_s if ex[:request_data]
+      example << "\n" << ex[:code].to_s
+      example << "\n" << format_example_data(ex[:response_data]).to_s if ex[:response_data]
+      example
+    end
+
+  end
+
+end

data/lib/apipie/param_description.rb

@@ -0,0 +1,87 @@
+module Apipie
+
+  # method parameter description
+  #
+  # name - method name (show)
+  # desc - description
+  # required - boolean if required
+  # validator - Validator::BaseValidator subclass
+  class ParamDescription
+
+    attr_reader :name, :desc, :required, :allow_nil, :validator
+
+    attr_accessor :parent
+
+    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 = Apipie.markup_to_html(options[:desc] || '')
+      @required = options[:required] || false
+      @allow_nil = options[:allow_nil] || false
+
+      @validator = nil
+      unless validator_type.nil?
+        @validator =
+          Validator::BaseValidator.find(self, validator_type, options, block)
+        raise "Validator not found." unless validator
+      end
+    end
+
+    def validate(value)
+      return true if @allow_nil && value.nil?
+      unless @validator.valid?(value)
+        raise ArgumentError.new(@validator.error)
+      end
+    end
+
+    def full_name
+      name_parts = parents_and_self.map(&:name)
+      return ([name_parts.first] + name_parts[1..-1].map { |n| "[#{n}]" }).join("")
+    end
+
+    # returns an array of all the parents: starting with the root parent
+    # ending with itself
+    def parents_and_self
+      ret = []
+      if self.parent
+        ret.concat(self.parent.parents_and_self)
+      end
+      ret << self
+      ret
+    end
+
+    def to_json
+      if validator.is_a? Apipie::Validator::HashValidator
+        {
+          :name => name.to_s,
+          :full_name => full_name,
+          :description => desc,
+          :required => required,
+          :allow_nil => allow_nil,
+          :validator => validator.to_s,
+          :expected_type => validator.expected_type,
+          :params => validator.hash_params_ordered.map(&:to_json)
+        }
+      else
+        {
+          :name => name.to_s,
+          :full_name => full_name,
+          :description => desc,
+          :required => required,
+          :allow_nil => allow_nil,
+          :validator => validator.to_s,
+          :expected_type => validator.expected_type
+        }
+      end
+    end
+
+  end
+
+end

data/lib/apipie/railtie.rb

@@ -0,0 +1,9 @@
+module Apipie
+  class Railtie < Rails::Railtie
+    initializer 'apipie.controller_additions' do
+      ActiveSupport.on_load :action_controller do
+        extend Apipie::DSL
+      end
+    end
+  end
+end

data/lib/apipie/resource_description.rb

@@ -0,0 +1,83 @@
+module Apipie
+
+  # Resource description
+  #
+  # version - api version (1)
+  # description
+  # path - relative path (/api/articles)
+  # methods - array of keys to Apipie.method_descriptions (array of Apipie::MethodDescription)
+  # name - human readable alias of resource (Articles)
+  # id - resouce name
+  class ResourceDescription
+
+    attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
+      :_path, :_version, :_name, :_params_ordered
+
+    def initialize(controller, resource_name, &block)
+      @_methods = []
+      @_params_ordered = []
+
+      @controller = controller
+      @_id = resource_name
+      @_version = "1"
+      @_name = @_id.humanize
+      @_full_description = ""
+      @_short_description = ""
+      @_path = ""
+
+      block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
+    end
+
+    def param(param_name, *args, &block)
+      param_description = Apipie::ParamDescription.new(param_name, *args, &block)
+      @_params_ordered << param_description
+    end
+
+    def path(path); @_path = path; end
+
+    def version(version); @_version = version; end
+
+    def name(name); @_name = name; end
+
+    def short(short); @_short_description = short; end
+    alias :short_description :short
+
+    def desc(description)
+      description ||= ''
+      @_full_description = Apipie.markup_to_html(description)
+    end
+    alias :description :desc
+    alias :full_description :desc
+
+    # add description of resource method
+    def add_method(mapi_key)
+      @_methods << mapi_key
+      @_methods.uniq!
+    end
+
+    def doc_url
+      Apipie.full_url(@_id)
+    end
+
+    def api_url; "#{Apipie.configuration.api_base_url}#{@_path}"; end
+
+    def to_json(method_name = nil)
+
+      _methods = if method_name.blank?
+        @_methods.collect { |key| Apipie.method_descriptions[key].to_json }
+      else
+        [Apipie.method_descriptions[[@_id, method_name].join('#')].to_json]
+      end
+
+      {
+        :doc_url => doc_url,
+        :api_url => api_url,
+        :name => @_name,
+        :short_description => @_short_description,
+        :full_description => @_full_description,
+        :version => @_version,
+        :methods => _methods
+      }
+    end
+  end
+end

data/lib/apipie/routing.rb

@@ -0,0 +1,13 @@
+module Apipie
+  module Routing
+    module MapperExtensions
+      def apipie
+        namespace "apipie", :path => Apipie.configuration.doc_base_url do
+          get("(:resource)/(:method)" => "apipies#index" )
+        end
+      end
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.send :include, Apipie::Routing::MapperExtensions

data/lib/apipie/static_dispatcher.rb

@@ -0,0 +1,60 @@
+module Apipie
+
+  class FileHandler
+    def initialize(root)
+      @root          = root.chomp('/')
+      @compiled_root = /^#{Regexp.escape(root)}/
+      @file_server   = ::Rack::File.new(@root)
+    end
+
+    def match?(path)
+      path = path.dup
+
+      full_path = path.empty? ? @root : File.join(@root, ::Rack::Utils.unescape(path))
+      paths = "#{full_path}#{ext}"
+
+      matches = Dir[paths]
+      match = matches.detect { |m| File.file?(m) }
+      if match
+        match.sub!(@compiled_root, '')
+        match
+      end
+    end
+
+    def call(env)
+      @file_server.call(env)
+    end
+
+    def ext
+      @ext ||= begin
+        ext = ::ActionController::Base.page_cache_extension
+        "{,#{ext},/index#{ext}}"
+      end
+    end
+  end
+
+  class StaticDispatcher
+    # Dispatches the statis files. Simillar to ActionDispatch::Static, but
+    # it supports different baseurl configurations
+    def initialize(app, path, baseurl)
+      @app = app
+      @baseurl = baseurl
+      @file_handler = Apipie::FileHandler.new(path)
+    end
+
+    def call(env)
+      case env['REQUEST_METHOD']
+      when 'GET', 'HEAD'
+        path = env['PATH_INFO'].sub("#{@baseurl}/","/apipie/").chomp('/')
+        path.sub!("#{ENV["RAILS_RELATIVE_URL_ROOT"]}",'')
+
+        if match = @file_handler.match?(path)
+          env["PATH_INFO"] = match
+          return @file_handler.call(env)
+        end
+      end
+
+      @app.call(env)
+    end
+  end
+end