Class: Apiculture::ActionDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/apiculture/action_definition.rb

Overview

Describes a single API action (route). Is used internally by Apiculture.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ActionDefinition

Returns a new instance of ActionDefinition.



27
28
29
 
# File 'lib/apiculture/action_definition.rb', line 27

def initialize
  @parameters, @route_parameters, @responses = [], [], []
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



3
4
5
 
# File 'lib/apiculture/action_definition.rb', line 3

def description
  @description
end

#http_verb ⇒ Object

Returns the value of attribute http_verb.



4
5
6
 
# File 'lib/apiculture/action_definition.rb', line 4

def http_verb
  @http_verb
end

#parameters ⇒ Object (readonly)

Returns the value of attribute parameters.



7
8
9
 
# File 'lib/apiculture/action_definition.rb', line 7

def parameters
  @parameters
end

#path ⇒ Object

Returns the value of attribute path.



5
6
7
 
# File 'lib/apiculture/action_definition.rb', line 5

def path
  @path
end

#responses ⇒ Object (readonly)

Returns the value of attribute responses.



9
10
11
 
# File 'lib/apiculture/action_definition.rb', line 9

def responses
  @responses
end

#route_parameters ⇒ Object (readonly)

Returns the value of attribute route_parameters.



8
9
10
 
# File 'lib/apiculture/action_definition.rb', line 8

def route_parameters
  @route_parameters
end

Instance Method Details

#all_parameter_names_as_strings ⇒ Object 



11
12
13
 
# File 'lib/apiculture/action_definition.rb', line 11

def all_parameter_names_as_strings
  @parameters.map(&:name_as_string) + @route_parameters.map(&:name_as_string)
end

#defines_request_params? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/apiculture/action_definition.rb', line 19

def defines_request_params?
  @parameters.any?
end

#defines_responses? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/apiculture/action_definition.rb', line 15

def defines_responses?
  @responses.any?
end

#defines_route_params? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/apiculture/action_definition.rb', line 23

def defines_route_params?
  @route_parameters.any?
end