Class: Apipie::MethodDescription

Inherits:
Object
  • Object
show all
Defined in:
lib/apipie/method_description.rb

Defined Under Namespace

Classes: Api

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method, resource, dsl_data) ⇒ MethodDescription

Returns a new instance of MethodDescription.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/apipie/method_description.rb', line 22

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

Instance Attribute Details

#apis ⇒ Object (readonly)

Returns the value of attribute apis.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def apis
  @apis
end

#examples ⇒ Object (readonly)

Returns the value of attribute examples.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def examples
  @examples
end

#formats ⇒ Object (readonly)

Returns the value of attribute formats.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def formats
  @formats
end

#full_description ⇒ Object (readonly)

Returns the value of attribute full_description.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def full_description
  @full_description
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def headers
  @headers
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def metadata
  @metadata
end

#method ⇒ Object (readonly)

Returns the value of attribute method.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def method
  @method
end

#resource ⇒ Object (readonly)

Returns the value of attribute resource.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def resource
  @resource
end

#see ⇒ Object (readonly)

Returns the value of attribute see.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def see
  @see
end

#show ⇒ Object (readonly)

Returns the value of attribute show.



20
21
22
 
# File 'lib/apipie/method_description.rb', line 20

def show
  @show
end

Instance Method Details

#create_api_url(api) ⇒ Object 



117
118
119
120
121
122
123
124
 
# File 'lib/apipie/method_description.rb', line 117

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

#doc_url ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/apipie/method_description.rb', line 109

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 ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/apipie/method_description.rb', line 88

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

#from_concern? ⇒ Boolean

was the description defines in a module instead of directly in controller?

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/apipie/method_description.rb', line 163

def from_concern?
  @from_concern
end

#id ⇒ Object 



60
61
62
 
# File 'lib/apipie/method_description.rb', line 60

def id
  "#{resource._id}##{method}"
end

#method_apis_to_json(lang = nil) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/apipie/method_description.rb', line 126

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 => resource._deprecated || api.options[:deprecated]
    }
  end
end

#params ⇒ Object 



64
65
66
 
# File 'lib/apipie/method_description.rb', line 64

def params
  params_ordered.reduce(ActiveSupport::OrderedHash.new) { |h,p| h[p.name] = p; h }
end

#params_ordered ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/apipie/method_description.rb', line 72

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

#params_ordered_self ⇒ Object 



68
69
70
 
# File 'lib/apipie/method_description.rb', line 68

def params_ordered_self
  @params_ordered
end

#to_json(lang = nil) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/apipie/method_description.rb', line 145

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

#version ⇒ Object 



105
106
107
 
# File 'lib/apipie/method_description.rb', line 105

def version
  resource._version
end