class Apipie::MethodDescription
Attributes
apis[R]
examples[R]
formats[R]
full_description[R]
method[R]
resource[R]
see[R]
Public Class Methods
new(method, resource, dsl_data)
click to toggle source
# File lib/apipie/method_description.rb, line 20 def initialize(method, resource, dsl_data) @method = method.to_s @resource = resource @from_concern = dsl_data[:from_concern] @apis = dsl_data[:api_args].map do |method, path, desc| MethodDescription::Api.new(method, concern_subst(path), concern_subst(desc)) end desc = dsl_data[:description] || '' @full_description = Apipie.markup_to_html(desc) @errors = dsl_data[:errors].map do |args| Apipie::ErrorDescription.new(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 @params_ordered = dsl_data[:params].map do |args| Apipie::ParamDescription.from_dsl_data(self, args) end @params_ordered = ParamDescription.unify(@params_ordered) end
Public Instance Methods
create_api_url(api)
click to toggle source
# File lib/apipie/method_description.rb, line 103 def create_api_url(api) path = "#{Apipie.api_base_url(@resource._version)}#{api.path}" path = path[0..-2] if path[-1..-1] == '/' return path end
doc_url()
click to toggle source
# File lib/apipie/method_description.rb, line 95 def doc_url crumbs = [] crumbs << @resource._version if Apipie.configuration.version_in_url crumbs << @resource._id crumbs << @method Apipie.full_url crumbs.join('/') end
errors()
click to toggle source
# File lib/apipie/method_description.rb, line 74 def errors return @merged_errors if @merged_errors @merged_errors = [] if @resource resource_errors = @resource._errors_args.map do |args| Apipie::ErrorDescription.new(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
from_concern?()
click to toggle source
was the description defines in a module instead of directly in controller?
# File lib/apipie/method_description.rb, line 142 def from_concern? @from_concern end
id()
click to toggle source
# File lib/apipie/method_description.rb, line 50 def id "#{resource._id}##{method}" end
method_apis_to_json()
click to toggle source
# File lib/apipie/method_description.rb, line 109 def method_apis_to_json @apis.each.collect do |api| { :api_url => create_api_url(api), :http_method => api.http_method.to_s, :short_description => api.short_description } end end
params()
click to toggle source
# File lib/apipie/method_description.rb, line 54 def params params_ordered.reduce(ActiveSupport::OrderedHash.new) { |h,p| h[p.name] = p; h } end
params_ordered()
click to toggle source
# File lib/apipie/method_description.rb, line 58 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
to_json()
click to toggle source
# File lib/apipie/method_description.rb, line 127 def to_json { :doc_url => doc_url, :name => @method, :apis => method_apis_to_json, :formats => formats, :full_description => @full_description, :errors => errors.map(&:to_json), :params => params_ordered.map(&:to_json).flatten, :examples => @examples, :see => see.map(&:to_json) } end
version()
click to toggle source
# File lib/apipie/method_description.rb, line 91 def version resource._version end
Private Instance Methods
concern_subst(string)
click to toggle source
# File lib/apipie/method_description.rb, line 180 def concern_subst(string) return if string.nil? if from_concern? resource.controller._apipie_perform_concern_subst(string) else string end end
format_example(ex)
click to toggle source
# File lib/apipie/method_description.rb, line 171 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
format_example_data(data)
click to toggle source
# File lib/apipie/method_description.rb, line 162 def format_example_data(data) case data when Array, Hash JSON.pretty_generate(data).gsub(/: \[\s*\]/,": []").gsub(/\{\s*\}/,"{}") else data end end
load_recorded_examples()
click to toggle source
# File lib/apipie/method_description.rb, line 154 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
merge_params(params, new_params)
click to toggle source
# File lib/apipie/method_description.rb, line 148 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