Class: Swagger::Blocks::Node

Inherits:

Object

• Object
• Swagger::Blocks::Node

Defined in:

lib/swagger/blocks.rb

Overview

Base node for representing every object in the Swagger DSL.

Direct Known Subclasses

AllOfNode, ApiAuthorizationNode, ApiAuthorizationScopeNode, ApiAuthorizationsNode, ApiDeclarationNode, ApiNode, AuthorizationCodeNode, ContactNode, ExampleNode, ExternalDocsNode, GrantTypesNode, HeaderNode, ImplicitNode, InfoNode, ItemsNode, LicenseNode, LoginEndpointNode, ModelNode, ModelsNode, OperationNode, ParameterNode, PathNode, PropertiesNode, PropertyNode, ResourceListingAuthorizationNode, ResourceListingAuthorizationsNode, ResourceNode, ResponseNode, RootNode, SchemaNode, ScopeNode, ScopesNode, SecurityRequirementNode, SecuritySchemeNode, TagNode, TokenEndpointNode, TokenRequestEndpointNode, XmlNode

Instance Attribute Summary

• #name ⇒ Object

  Returns the value of attribute name.

• #version ⇒ Object

Class Method Summary

• .call(options = {}, &block) ⇒ Object

Instance Method Summary

• #as_json ⇒ Object
• #data ⇒ Object
• #is_swagger_1_2? ⇒ Boolean
• #is_swagger_2_0? ⇒ Boolean
• #key(key, value) ⇒ Object

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.

# File 'lib/swagger/blocks.rb', line 212

def name
  @name
end

#version ⇒ Object

# File 'lib/swagger/blocks.rb', line 255

def version
  return @version if instance_variable_defined?('@version') && @version
  if data.has_key?(:swagger) && data[:swagger] == '2.0'
    '2.0'
  elsif data.has_key?(:swaggerVersion) && data[:swaggerVersion] == '1.2'
    '1.2'
  else
    raise DeclarationError.new("You must specify swaggerVersion '1.2' or swagger '2.0'")
  end
end

Class Method Details

.call(options = {}, &block) ⇒ Object

# File 'lib/swagger/blocks.rb', line 215

def self.call(options = {}, &block)
  # Create a new instance and evaluate the block into it.
  instance = new
  instance.name = options[:name] if options[:name]
  instance.version = options[:version]
  instance.instance_eval(&block)
  instance
end

Instance Method Details

#as_json ⇒ Object

# File 'lib/swagger/blocks.rb', line 224

def as_json
  result = {}

  self.data.each do |key, value|
    if value.is_a?(Node)
      result[key] = value.as_json
    elsif value.is_a?(Array)
      result[key] = []
      value.each { |v| result[key] << (v.respond_to?(:as_json) ? v.as_json : v) }
    elsif is_swagger_2_0? && value.is_a?(Hash)
      result[key] = {}
      value.each_pair {|k, v| result[key][k] = (v.respond_to?(:as_json) ? v.as_json : v) }
    elsif is_swagger_2_0? && key.to_s.eql?('$ref') && (value.to_s !~ %r{^#/definitions/})
      result[key] = "#/definitions/#{value}"
    else
      result[key] = value
    end
  end
  return result if !name
  # If 'name' is given to this node, wrap the data with a root element with the given name.
  {name => result}
end

#data ⇒ Object

# File 'lib/swagger/blocks.rb', line 247

def data
  @data ||= {}
end

#is_swagger_1_2? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/swagger/blocks.rb', line 266

def is_swagger_1_2?
  version == '1.2'
end

#is_swagger_2_0? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/swagger/blocks.rb', line 270

def is_swagger_2_0?
  version == '2.0'
end

#key(key, value) ⇒ Object

# File 'lib/swagger/blocks.rb', line 251

def key(key, value)
  self.data[key] = value
end