Class: Swagger::Data::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-swagger/data/document.rb

Overview

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#swagger-object

Constant Summary collapse

SPEC_VERSION =

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#fixed-fields

'2.0'
DEFAULT_HOST = 
'localhost:80'

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

attr_swagger, #bulk_set, #swagger_attributes, #to_json, #to_swagger, #to_yaml

Constructor Details

#initialize ⇒ Document

create an empty document



25
26
27
28
29
 
# File 'lib/ruby-swagger/data/document.rb', line 25

def initialize
  @swagger = '2.0'
  @info = Swagger::Data::Info.new
  @paths = Swagger::Data::Paths.new
end

Class Method Details

.parse(document) ⇒ Object

parse an hash document into a set of Swagger objects

document is a hash



33
34
35
36
37
 
# File 'lib/ruby-swagger/data/document.rb', line 33

def self.parse(document)
  raise (ArgumentError.new("Swagger::Document#parse - document object is nil")) unless document

  Swagger::Data::Document.new.bulk_set(document)
end

Instance Method Details

#add_tag(new_tag) ⇒ Object 



160
161
162
163
164
165
166
167
168
 
# File 'lib/ruby-swagger/data/document.rb', line 160

def add_tag(new_tag)
  return nil unless new_tag

  if (!new_tag.is_a?(Swagger::Data::Tag))
    new_tag = Swagger::Data::Tag.parse(new_tag)
  end

  @tags.push(new_tag)
end

#basePath=(new_path) ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/ruby-swagger/data/document.rb', line 52

def basePath=(new_path)
  new_path = new_path.nil? ? '/' : new_path

  if !(new_path =~ /^\/.+$/)
    new_path = "/#{new_path}" #new path must start with a /
  end

  @basePath ||= new_path
end

#consumes=(new_consumes) ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'lib/ruby-swagger/data/document.rb', line 82

def consumes=(new_consumes)
  return nil unless new_consumes

  new_consumes.each do |consume|
    raise (ArgumentError.new("Swagger::Data::Document#consumes= - unrecognized consume type #{consume}]")) unless Swagger::Data::Mime.valid?(consume)
  end

  @consumes= new_consumes
end

#definitions=(new_definitions) ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/ruby-swagger/data/document.rb', line 100

def definitions=(new_definitions)
  return nil unless new_definitions

  if (!new_definitions.is_a?(Swagger::Data::Definitions))
    new_definitions = Swagger::Data::Definitions.parse(new_definitions)
  end

  @definitions = new_definitions
end

#externalDocs=(new_externalDocs) ⇒ Object 



170
171
172
173
174
175
176
177
178
 
# File 'lib/ruby-swagger/data/document.rb', line 170

def externalDocs=(new_externalDocs)
  return nil unless new_externalDocs

  if (!new_externalDocs.is_a?(Swagger::Data::ExternalDocumentation))
    new_externalDocs = Swagger::Data::ExternalDocumentation.parse(new_externalDocs)
  end

  @externalDocs = new_externalDocs
end

#info=(new_info) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/ruby-swagger/data/document.rb', line 44

def info=(new_info)
  raise (ArgumentError.new("Swagger::Document#info= - info object is nil")) unless new_info

  new_info = Swagger::Data::Info.parse(new_info) unless new_info.is_a?(Swagger::Data::Info)

  @info = new_info
end

#parameters=(new_parameters) ⇒ Object 



110
111
112
113
114
115
116
117
118
 
# File 'lib/ruby-swagger/data/document.rb', line 110

def parameters=(new_parameters)
  return nil unless new_parameters

  if (!new_parameters.is_a?(Swagger::Data::Parameters))
    new_parameters = Swagger::Data::Parameters.parse(new_parameters)
  end

  @parameters = new_parameters
end

#paths=(new_paths) ⇒ Object

Raises:

  • (ArgumentError) 


92
93
94
95
96
97
98
 
# File 'lib/ruby-swagger/data/document.rb', line 92

def paths=(new_paths)
  raise ArgumentError.new("Swagger::Data::Document#paths= - paths is nil") unless paths

  new_paths = Swagger::Data::Paths.parse(new_paths) if(!new_paths.is_a?(Swagger::Data::Paths))

  @paths = new_paths
end

#produces=(new_produces) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/ruby-swagger/data/document.rb', line 72

def produces=(new_produces)
  return nil unless new_produces

  new_produces.each do |produce|
    raise (ArgumentError.new("Swagger::Data::Document#produces= - unrecognized produce type #{produce}")) unless Swagger::Data::Mime.valid?(produce)
  end

  @produces = new_produces
end

#responses=(new_responses) ⇒ Object 



120
121
122
123
124
125
126
127
128
 
# File 'lib/ruby-swagger/data/document.rb', line 120

def responses=(new_responses)
  return nil unless new_responses

  if (!new_responses.is_a?(Swagger::Data::Responses))
    new_responses = Swagger::Data::Responses.parse(new_responses)
  end

  @responses = new_responses
end

#schemes=(new_schemes) ⇒ Object 



62
63
64
65
66
67
68
69
70
 
# File 'lib/ruby-swagger/data/document.rb', line 62

def schemes=(new_schemes)
  return nil unless new_schemes

  new_schemes.each do |scheme|
    raise (ArgumentError.new("Swagger::Data::Document#schemes= - unrecognized scheme #{scheme}")) unless %w(http https ws wss).include?(scheme)
  end

  @schemes = new_schemes
end

#security=(new_security) ⇒ Object 



140
141
142
143
144
145
146
147
148
 
# File 'lib/ruby-swagger/data/document.rb', line 140

def security=(new_security)
  return nil unless new_security

  if (!new_security.is_a?(Swagger::Data::SecurityRequirement))
    new_security = Swagger::Data::SecurityRequirement.parse(new_security)
  end

  @security = new_security
end

#securityDefinitions=(newSecurityDef) ⇒ Object 



130
131
132
133
134
135
136
137
138
 
# File 'lib/ruby-swagger/data/document.rb', line 130

def securityDefinitions=(newSecurityDef)
  return nil unless newSecurityDef

  if (!newSecurityDef.is_a?(Swagger::Data::SecurityDefinitions))
    newSecurityDef = Swagger::Data::SecurityDefinitions.parse(newSecurityDef)
  end

  @securityDefinitions= newSecurityDef
end

#swagger=(new_swagger) ⇒ Object 



39
40
41
42
 
# File 'lib/ruby-swagger/data/document.rb', line 39

def swagger=(new_swagger)
  raise (ArgumentError.new("Swagger::Document#swagger= - the document is not a swagger #{SPEC_VERSION} version")) unless "2.0" == new_swagger
  @swagger = new_swagger
end

#tags=(new_tags) ⇒ Object 



150
151
152
153
154
155
156
157
158
 
# File 'lib/ruby-swagger/data/document.rb', line 150

def tags=(new_tags)
  return nil unless new_tags

  @tags = []

  new_tags.each do |tag|
    add_tag(tag)
  end
end