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 - resource name # formats - acceptable request/response format types # headers - array of headers # deprecated - boolean indicating if resource is deprecated class ResourceDescription attr_reader :controller, :_short_description, :_full_description, :_methods, :_id, :_path, :_params_args, :_returns_args, :_tag_list_arg, :_errors_args, :_formats, :_parent, :_metadata, :_headers, :_deprecated def initialize(controller, id, dsl_data = nil, version = nil) @_methods = ActiveSupport::OrderedHash.new @_params_args = [] @_errors_args = [] @_returns_args = [] @controller = controller @_id = id @_version = version || Apipie.configuration.default_version @_parent = Apipie.value_from_parents(controller.superclass, version) do |parent, ver| Apipie.get_resource_description(parent, ver) end update_from_dsl_data(dsl_data) if dsl_data end def update_from_dsl_data(dsl_data) @_resource_name = dsl_data[:resource_name] if dsl_data[:resource_name] @_full_description = dsl_data[:description] @_short_description = dsl_data[:short_description] @_path = dsl_data[:path] || "" @_formats = dsl_data[:formats] @_errors_args = dsl_data[:errors] @_params_args = dsl_data[:params] @_returns_args = dsl_data[:returns] @_tag_list_arg = dsl_data[:tag_list] @_metadata = dsl_data[:meta] @_api_base_url = dsl_data[:api_base_url] @_headers = dsl_data[:headers] @_deprecated = dsl_data[:deprecated] || false if dsl_data[:app_info] Apipie.configuration.app_info[_version] = dsl_data[:app_info] end end def _version @_version || @_parent.try(:_version) || Apipie.configuration.default_version end def _api_base_url @_api_base_url || @_parent.try(:_api_base_url) || Apipie.api_base_url(_version) end def name @name ||= case resource_name when Proc resource_name.call(controller) when Symbol controller.public_send(resource_name) when String resource_name else default_name end end alias _name name def add_method_description(method_description) Apipie.debug "@resource_descriptions[#{self._version}][#{self._id}]._methods[#{method_description.method}] = #{method_description}" @_methods[method_description.method.to_sym] = method_description end def method_description(method_name) @_methods[method_name.to_sym] end def remove_method_description(method_name) if @_methods.key?(method_name) @_methods.delete(method_name) end end def method_descriptions @_methods.values end def doc_url crumbs = [] crumbs << _version if Apipie.configuration.version_in_url crumbs << @_id Apipie.full_url crumbs.join('/') end def api_url "#{Apipie.api_base_url(_version)}#{@_path}" end def valid_method_name?(method_name) @_methods.keys.map(&:to_s).include?(method_name.to_s) end def to_json(method_name = nil, lang = nil) if method_name && !valid_method_name?(method_name) raise "Method #{method_name} not found for resource #{_name}" end methods = if method_name.blank? @_methods.collect { |key, method_description| method_description.to_json(lang) } else [@_methods[method_name.to_sym].to_json(lang)] end { :doc_url => doc_url, :id => _id, :api_url => api_url, :name => name, :short_description => Apipie.app.translate(@_short_description, lang), :full_description => Apipie.markup_to_html(Apipie.app.translate(@_full_description, lang)), :version => _version, :formats => @_formats, :metadata => @_metadata, :methods => methods, :headers => _headers, :deprecated => @_deprecated } end protected def resource_name @_resource_name.presence || @_parent&.resource_name end private def default_name @_id.split('-').map(&:capitalize).join('::') end end end