Class: Raddocs::Example

Inherits:
Object
  • Object
show all
Defined in:
lib/raddocs/models.rb

Overview

Example page model

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file) ⇒ Example

Returns a new instance of Example.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/raddocs/models.rb', line 52

def initialize(file)
  @attrs = JSON.parse(File.read(file))
  @resource_explanation = @attrs.fetch("resource_explanation", nil)
  @resource = @attrs.fetch("resource")
  
  @description = @attrs.fetch("description")
  @explanation = @attrs.fetch("explanation", nil)
  @parameters = Parameters.new(@attrs.fetch("parameters"))
  @response_fields = ResponseFields.new(@attrs.fetch("response_fields", []))
  @requests = @attrs.fetch("requests").map { |request| Request.new(request) }
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def description
  @description
end

#explanation ⇒ Object (readonly)

Returns the value of attribute explanation.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def explanation
  @explanation
end

#parameters ⇒ Object (readonly)

Returns the value of attribute parameters.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def parameters
  @parameters
end

#requests ⇒ Object (readonly)

Returns the value of attribute requests.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def requests
  @requests
end

#resource ⇒ Object (readonly)

Returns the value of attribute resource.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def resource
  @resource
end

#resource_explanation ⇒ Object (readonly)

Returns the value of attribute resource_explanation.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def resource_explanation
  @resource_explanation
end

#response_fields ⇒ Object (readonly)

Returns the value of attribute response_fields.



49
50
51
 
# File 'lib/raddocs/models.rb', line 49

def response_fields
  @response_fields
end

Instance Method Details

#explanation? ⇒ Boolean

Returns true if explanation is present.

Returns:

  • (Boolean) —

    true if explanation is present



65
66
67
 
# File 'lib/raddocs/models.rb', line 65

def explanation?
  !explanation.nil?
end

#resource_explanation? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/raddocs/models.rb', line 69

def resource_explanation?
  !resource_explanation.nil?
end