require 'set' module Apipie class MethodDescription class Api attr_accessor :short_description, :path, :http_method, :from_routes, :options def initialize(method, path, desc, options) @http_method = method.to_s @path = path @short_description = desc @from_routes = options[:from_routes] @options = options end end attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats, :metadata, :headers, :show def initialize(method, resource, dsl_data) @method = method.to_s @resource = resource @from_concern = dsl_data[:from_concern] @apis = api_data(dsl_data).map do |mthd, path, desc, opts| MethodDescription::Api.new(mthd, concern_subst(path), concern_subst(desc), opts) end desc = dsl_data[:description] || '' @full_description = Apipie.markup_to_html(desc) @errors = dsl_data[:errors].map do |args| Apipie::ErrorDescription.from_dsl_data(args) end @see = dsl_data[:see].map do |args| Apipie::SeeDescription.new(args) end @formats = dsl_data[:formats] @examples = dsl_data[:examples] @examples += load_recorded_examples @metadata = dsl_data[:meta] @params_ordered = dsl_data[:params].map do |args| Apipie::ParamDescription.from_dsl_data(self, args) end @params_ordered = ParamDescription.unify(@params_ordered) @headers = dsl_data[:headers] @show = if dsl_data.has_key? :show dsl_data[:show] else true end end def id "#{resource._id}##{method}" end def params params_ordered.reduce(ActiveSupport::OrderedHash.new) { |h,p| h[p.name] = p; h } end def params_ordered_self @params_ordered end def params_ordered all_params = [] parent = Apipie.get_resource_description(@resource.controller.superclass) # get params from parent resource description [parent, @resource].compact.each do |resource| resource_params = resource._params_args.map do |args| Apipie::ParamDescription.from_dsl_data(self, args) end merge_params(all_params, resource_params) end merge_params(all_params, @params_ordered) all_params.find_all(&:validator) end def errors return @merged_errors if @merged_errors @merged_errors = [] if @resource resource_errors = @resource._errors_args.map do |args| Apipie::ErrorDescription.from_dsl_data(args) end # exclude overwritten parent errors @merged_errors = resource_errors.find_all do |err| !@errors.any? { |e| e.code == err.code } end end @merged_errors.concat(@errors) return @merged_errors end def version resource._version end def doc_url crumbs = [] crumbs << @resource._version if Apipie.configuration.version_in_url crumbs << @resource._id crumbs << @method Apipie.full_url crumbs.join('/') end def create_api_url(api) path = api.path unless api.from_routes path = "#{@resource._api_base_url}#{path}" end path = path[0..-2] if path[-1..-1] == '/' return path end def method_apis_to_json(lang = nil) @apis.each.collect do |api| { :api_url => create_api_url(api), :http_method => api.http_method.to_s, :short_description => Apipie.app.translate(api.short_description, lang), :deprecated => api.options[:deprecated] } end end def see @see end def formats @formats || @resource._formats end def to_json(lang=nil) { :doc_url => doc_url, :name => @method, :apis => method_apis_to_json(lang), :formats => formats, :full_description => Apipie.app.translate(@full_description, lang), :errors => errors.map(&:to_json), :params => params_ordered.map{ |param| param.to_json(lang) }.flatten, :examples => @examples, :metadata => @metadata, :see => see.map(&:to_json), :headers => headers, :show => @show } end # was the description defines in a module instead of directly in controller? def from_concern? @from_concern end private def api_data(dsl_data) ret = dsl_data[:api_args].dup if dsl_data[:api_from_routes] desc = dsl_data[:api_from_routes][:desc] options = dsl_data[:api_from_routes][:options] api_from_routes = Apipie.routes_for_action(resource.controller, method, {:desc => desc, :options => options}).map do |route_info| [route_info[:verb], route_info[:path], route_info[:desc], (route_info[:options] || {}).merge(:from_routes => true)] end ret.concat(api_from_routes) end ret end 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 }. find_all { |ex| ex["versions"].nil? || ex["versions"].include?(self.version) }. 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 = "" example << "// #{ex[:title]}\n" if ex[:title].present? 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 def concern_subst(string) return if string.nil? if from_concern? resource.controller._apipie_perform_concern_subst(string) else string end end end end